Class: Fastlane::Actions::CpdAnalyzerAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb

Constant Summary collapse

SUPPORTED_LAN = 
['python', 'objectivec', 'jsp', 'ecmascript', 'fortran', 'cpp', 'ruby', 'php', 'java', 'matlab', 'scala', 'plsql', 'go', 'cs']

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



132
133
134
135
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 132

def self.authors
  # So no one will ever forget your contribution to fastlane :) You are awesome btw!
  ["olgakn"]
end

.available_options ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 79

def self.available_options
  # Define all options your action supports.
  [
    FastlaneCore::ConfigItem.new(key: :result_dir,
                  env_name: "FL_CPD_ANALYZER_RESULT_DIR",
                  description: "Directory's name for storing  analysis results",
                  optional: true,
                  type: String,
                  default_value: 'artifacts'),
    FastlaneCore::ConfigItem.new(key: :use_junit_format,
                  env_name: "FL_CPD_ANALYZER_USE_JUNIT_RESULTS",
                  description: "Generate results in JUnit format.",
                  optional: true,
                  type: BOOL,
                  default_value: true),
    FastlaneCore::ConfigItem.new(key: :tokens,
                  env_name: "FL_CPD_ANALYZER_TOKENS",
                  description: "The min number of words in code that is detected as copy paste",
                  optional: true,
                  type: String,
                  default_value: '100'),
    FastlaneCore::ConfigItem.new(key: :cpd_files_to_inspect,
                  env_name: "FL_CPD_ANALYZER_FILES_TO_INSPECT",
                  description: "List of files and directories (relative to work directory) to inspect on copy paste",
                  optional: true,
                  type: Array),
    FastlaneCore::ConfigItem.new(key: :cpd_files_to_exclude,
                  env_name: "FL_CPD_ANALYZER_FILES_NOT_TO_INSPECT",
                  description: "List of files and directories (relative to work directory) not to inspect on copy paste",
                  optional: true,
                  type: Array),
    FastlaneCore::ConfigItem.new(key: :language,
                  env_name: "FL_CPD_ANALYZER_FILE_LANGUAGE",
                  description: "Language used in files that will be inspected on copy paste.\nSupported analyzers: #{SUPPORTED_LAN} or don't set if you need any other language",
                  optional: true,
                  type: String,
                  verify_block: proc do |value|
                    UI.user_error!("This language is not supported.  Supported languages: #{SUPPORTED_LAN} or empty if you need any other language") unless SUPPORTED_LAN.map(&:downcase).include? value.downcase or value.empty? or !value
                  end)
  ]
end

.description ⇒ Object 



68
69
70
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 68

def self.description
  "This analyzer detect copy paste code (it uses PMD CPD)"
end

.details ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 72

def self.details
  # Optional:
  # this is your chance to provide a more detailed description of this action
  "Important: install PMD if you want to use copy paste detector\n" \
  "Important: Always use 'language' parameter except the needed language isn't available in list of supported languages"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 137

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



121
122
123
124
125
126
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 121

def self.output
  # Define the shared values you are going to provide
  [
    ['CPD_ANALYZER_STATUS', 'Copy paste analyzer result status (0 - success, any other value - failed)']
  ]
end

.return_value ⇒ Object 



128
129
130
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 128

def self.return_value
  # If you method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fastlane/plugin/code_static_analyzer/actions/cpd_analyzer.rb', line 10

def self.run(params)
  UI.header 'CPD analyzer' if Actions::CodeStaticAnalyzerAction.run_from_main_action
  Actions::CodeStaticAnalyzerAction.is_pmd_installed unless Actions::CodeStaticAnalyzerAction.checked_pmd
  work_dir = Actions::CodeStaticAnalyzerAction.work_dir
  # checking files for analysing
  files_to_exclude = params[:cpd_files_to_exclude]
  files_to_inspect = params[:cpd_files_to_inspect]
  UI.message '[!] CPD analyzer will be run for all files in work directory'.blue if !files_to_inspect or files_to_inspect.empty?
  Actions::CodeStaticAnalyzerAction.check_file_exist(work_dir, files_to_exclude, 'cpd_files_to_exclude') if files_to_exclude
  Actions::CodeStaticAnalyzerAction.check_file_exist(work_dir, files_to_inspect, 'cpd_files_to_inspect') if files_to_inspect

  # prepare script and metadata for saving results
  result_dir_path = "#{work_dir}#{params[:result_dir]}"
  FileUtils.mkdir_p(result_dir_path) unless File.exist?(result_dir_path)
  temp_result_file = "#{result_dir_path}/cpd.xml"
  result_file = "#{result_dir_path}/codeAnalysResults_cpd.xml"
  tokens = params[:tokens]
  files = Actions::CodeStaticAnalyzerAction.add_root_path(work_dir, files_to_inspect, true)
  lan = params[:language]
  exclude_files = Actions::CodeStaticAnalyzerAction.add_root_path(work_dir, files_to_exclude, false)
  run_script = " pmd cpd --minimum-tokens #{tokens} --files #{files}"
  run_script += " --exclude #{exclude_files}" unless exclude_files == ''
  run_script += " --language #{lan}" unless (lan and lan.empty?) or !lan
  run_script += " --format xml"
  run_script_path = File.join CodeStaticAnalyzer::ROOT, "assets/run_script.sh"
  run_script = "#{run_script_path} \"#{run_script}\" '#{temp_result_file}'"
  # use analyzer
  Formatter.cpd_format(tokens, lan, exclude_files, temp_result_file, files)
  FastlaneCore::CommandExecutor.execute(command: run_script.to_s,
                                      print_all: false,
                                      error: proc do |error_output|
                                               # handle error here
                                             end)
  status = $?.exitstatus

  # prepare results
  if Dir.glob(temp_result_file).empty? or status == 1
    Actions::CodeStaticAnalyzerAction.start_xml_content unless Actions::CodeStaticAnalyzerAction.run_from_main_action
    info = (status == 1) ? "CPD return 1: Couldn't understand command line parameters or CPD exited with an exception" : ''
    Actions::CodeStaticAnalyzerAction.add_xml_content("#{result_dir_path}/", 'Copy paste', temp_result_file, info)
    Actions::CodeStaticAnalyzerAction.create_analyzers_run_result("#{result_dir_path}/") unless Actions::CodeStaticAnalyzerAction.run_from_main_action
    status = 43
  else
    status = 0 if File.read(temp_result_file).empty?
    if params[:use_junit_format]
   UI.message 'CPD analyzer generates result in JUnit format'
      xml_content = JunitParser.parse_xml(temp_result_file)
      junit_xml = JunitParser.add_testsuite('copypaste', xml_content)
      JunitParser.create_junit_xml(junit_xml, result_file)
    end
  end
  Actions.lane_context[SharedValues::CPD_ANALYZER_STATUS] = status
end