Class: Fastlane::Actions::DetectDuplicityCodeAction

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

Overview

重复代码检查

Class Method Summary collapse

Class Method Details

.available_options ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb', line 76

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :is_all,
      description: "是否检查所有文件",
      optional: true,
      default_value: true,
      type: Boolean
    ),
    FastlaneCore::ConfigItem.new(
      key: :commit_hash,
      description: "上一次提交哈希, 会比较该哈希到最新哈希",
      optional: true,
      default_value: nil,
      type: String
    )
  ]
end

.category ⇒ Object 



99
100
101
 
# File 'lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb', line 99

def self.category
  :testing
end

.description ⇒ Object 



72
73
74
 
# File 'lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb', line 72

def self.description
  "重复代码检测"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb', line 95

def self.is_supported?(platform)
  platform == :ios
end

.run(params) ⇒ Object 



8
9
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
63
64
65
66
67
68
69
70
 
# File 'lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb', line 8

def self.run(params)
  UI.message("*************| 开始重复代码检查 |*************")

  # 检查是否安装了 PMD
  unless system("which pmd > /dev/null")
    sh("brew install pmd")
  end

  is_all = params[:is_all] || true
  # 项目路径
  project_path = Dir.pwd

  if is_all
    detect_path = "#{project_path}"
    pmd_command = "--dir #{detect_path}"
  else
    commit_hash = params[:commit_hash] || CommonHelper.read_cached_txt(COMMIT_HASH_FILE)
    swift_files = CommonHelper.get_git_modified_swift_files(commit_hash)

    if swift_files.empty?
      UI.message("*************|❗没有 Swift 变更文件，跳过重复代码检查❗|*************")
      return
    end

    # 创建文件列表
    file_list_path = Constants.DUPLICITY_CODE_MODIFIED_FILE
    swift_files_absolute = swift_files.map { |file| File.expand_path(file, project_path) }
    File.open(file_list_path, "w") { |file| file.puts(swift_files_absolute) }

    pmd_command = "--file-list #{file_list_path}"
  end

  # 忽略文件夹
  ignore_paths = [
    "#{project_path}/Pods/**"
  ]
  exclude_options = ignore_paths.map { |path| "--exclude #{path}" }.join(" ")

  sh("
    pmd cpd \
    --minimum-tokens 100 \
    #{pmd_command} \
    --language swift \
    --format xml \
    #{exclude_options} \
    --ignore-annotations \
    --ignore-identifiers \
    --ignore-literals \
    --no-fail-on-error \
    --no-fail-on-violation \
    > #{Constants.DUPLICITY_CODE_FILE}
  ")

  # 输出无用代码检查报告
  UI.message("*************| 开始输出重复代码检查报告 |*************")

  CommonHelper.generate_and_open_html(
    "Duplicity Code Report",
    "generate_duplicity_code_html.py",
    Constants.DUPLICITY_CODE_FILE,
    Constants.DUPLICITY_CODE_HTML_FILE
  )
end