Class: Fastlane::Actions::LcovAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/lcov.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, details, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorObject


44
45
46
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 44

def self.author
  "thiagolioy"
end

.available_optionsObject


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 19

def self.available_options
  [

    FastlaneCore::ConfigItem.new(key: :project_name,
                                 env_name: "FL_LCOV_PROJECT_NAME",
                                 description: "Name of the project"),

    FastlaneCore::ConfigItem.new(key: :scheme,
                                 env_name: "FL_LCOV_SCHEME",
                                 description: "Scheme of the project"),

    FastlaneCore::ConfigItem.new(key: :arch,
                                 env_name: "FL_LCOV_ARCH",
                                 description: "The build arch where will search .gcda files",
                                 default_value: "i386"),

    FastlaneCore::ConfigItem.new(key: :output_dir,
                                 env_name: "FL_LCOV_OUTPUT_DIR",
                                 description: "The output directory that coverage data will be stored. If not passed will use coverage_reports as default value",
                                 optional: true,
                                 is_string: true,
                                 default_value: "coverage_reports")
  ]
end

.categoryObject


97
98
99
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 97

def self.category
  :testing
end

.derived_data_dir(options) ⇒ Object


66
67
68
69
70
71
72
73
74
75
76
77
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 66

def self.derived_data_dir(options)
  pn = options[:project_name]
  sc = options[:scheme]
  arch = options[:arch]

  initial_path = "#{Dir.home}/Library/Developer/Xcode/DerivedData/"
  end_path = "/Build/Intermediates/#{pn}.build/Debug-iphonesimulator/#{sc}.build/Objects-normal/#{arch}/"

  match = find_project_dir(pn, initial_path)

  "#{initial_path}#{match}#{end_path}"
end

.descriptionObject


15
16
17
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 15

def self.description
  "Generates coverage data using lcov"
end

.example_codeObject


87
88
89
90
91
92
93
94
95
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 87

def self.example_code
  [
    'lcov(
      project_name: "ProjectName",
      scheme: "yourScheme",
      output_dir: "cov_reports" # This value is optional. Default is coverage_reports
    )'
  ]
end

.exclude_dirsObject


83
84
85
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 83

def self.exclude_dirs
  ["/Applications/*", "/Frameworks/*"]
end

.find_project_dir(project_name, path) ⇒ Object


79
80
81
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 79

def self.find_project_dir(project_name, path)
  `ls -t #{path}| grep #{project_name} | head -1`.to_s.delete("\n")
end

.gen_cov(options) ⇒ Object


48
49
50
51
52
53
54
55
56
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 48

def self.gen_cov(options)
  tmp_cov_file = "/tmp/coverage.info"
  output_dir = options[:output_dir]
  derived_data_path = derived_data_dir(options)

  system("lcov --capture --directory \"#{derived_data_path}\" --output-file #{tmp_cov_file}")
  system(gen_lcov_cmd(tmp_cov_file))
  system("genhtml #{tmp_cov_file} --output-directory #{output_dir}")
end

.gen_lcov_cmd(cov_file) ⇒ Object


58
59
60
61
62
63
64
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 58

def self.gen_lcov_cmd(cov_file)
  cmd = "lcov "
  exclude_dirs.each do |e|
    cmd << "--remove #{cov_file} \"#{e}\" "
  end
  cmd << "--output #{cov_file} "
end

.is_supported?(platform) ⇒ Boolean

Returns:


4
5
6
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 4

def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end

.run(options) ⇒ Object


8
9
10
11
12
13
# File 'fastlane/lib/fastlane/actions/lcov.rb', line 8

def self.run(options)
  unless Helper.test?
    UI.user_error!("lcov not installed, please install using `brew install lcov`") if `which lcov`.length == 0
  end
  gen_cov(options)
end