fastlane-plugin-clang_tools 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +52 -0
- data/lib/fastlane/plugin/clang_tools.rb +16 -0
- data/lib/fastlane/plugin/clang_tools/actions/clang_analyzer_action.rb +368 -0
- data/lib/fastlane/plugin/clang_tools/helper/clang_analyzer_helper.rb +16 -0
- data/lib/fastlane/plugin/clang_tools/version.rb +5 -0
- metadata +174 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a6829b16af1e5f3edace18b386a9e821e889e7854a0cf62210e46a54466461e6
|
4
|
+
data.tar.gz: '0138bf93626ca825ef6403a3d6fefbb538ecf86eebb970c2288e443673376f30'
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5128d365f740b672a097d78d13f1209cdb3e9a0599806aabe8e42c3db2382204d9bd2204f060979897e0d32df2971035d42bd1e5a1bf372910c9d7b038f50f60
|
7
|
+
data.tar.gz: f607dbe8f57ea5cc4849da6a29145a2478bbfac872f5a5421062d8347bdc4fffdf356f671b7a32000d7326c7355a71c591fc9d7301fb64ac7530fbe44f4b27b8
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# clang_tools plugin
|
2
|
+
|
3
|
+
[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-clang_tools)
|
4
|
+
|
5
|
+
## Getting Started
|
6
|
+
|
7
|
+
This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-clang_tools`, add it to your project by running:
|
8
|
+
|
9
|
+
```bash
|
10
|
+
fastlane add_plugin clang_tools
|
11
|
+
```
|
12
|
+
|
13
|
+
## About clang_tools
|
14
|
+
|
15
|
+
A series of clang-based tools for CI/CD.
|
16
|
+
|
17
|
+
**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
|
22
|
+
|
23
|
+
**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
|
24
|
+
|
25
|
+
## Run tests for this plugin
|
26
|
+
|
27
|
+
To run both the tests, and code style validation, run
|
28
|
+
|
29
|
+
```
|
30
|
+
rake
|
31
|
+
```
|
32
|
+
|
33
|
+
To automatically fix many of the styling issues, use
|
34
|
+
```
|
35
|
+
rubocop -a
|
36
|
+
```
|
37
|
+
|
38
|
+
## Issues and Feedback
|
39
|
+
|
40
|
+
For any other issues and feedback about this plugin, please submit it to this repository.
|
41
|
+
|
42
|
+
## Troubleshooting
|
43
|
+
|
44
|
+
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
|
45
|
+
|
46
|
+
## Using _fastlane_ Plugins
|
47
|
+
|
48
|
+
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
|
49
|
+
|
50
|
+
## About _fastlane_
|
51
|
+
|
52
|
+
_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'fastlane/plugin/clang_tools/version'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
module ClangTools
|
5
|
+
# Return all .rb files inside the "actions" and "helper" directory
|
6
|
+
def self.all_classes
|
7
|
+
Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
# By default we want to import all available actions and helpers
|
13
|
+
# A plugin can contain any number of actions and plugins
|
14
|
+
Fastlane::ClangTools.all_classes.each do |current|
|
15
|
+
require current
|
16
|
+
end
|
@@ -0,0 +1,368 @@
|
|
1
|
+
require 'fastlane/action'
|
2
|
+
require_relative '../helper/clang_analyzer_helper'
|
3
|
+
|
4
|
+
module Fastlane
|
5
|
+
module Actions
|
6
|
+
class ClangAnalyzerAction < Action
|
7
|
+
def self.run(params)
|
8
|
+
# Parse CLI parameters
|
9
|
+
analyze_params = prepare(params)
|
10
|
+
if analyze_params.nil?
|
11
|
+
puts('ERROR : Invalid parameters. Exiting ......')
|
12
|
+
return
|
13
|
+
end
|
14
|
+
|
15
|
+
# Use xcodebuild to generate compilation database
|
16
|
+
unless xcode_build(analyze_params)
|
17
|
+
puts('ERROR : Failed to build project. Exiting ......')
|
18
|
+
return
|
19
|
+
end
|
20
|
+
|
21
|
+
# Use clang analyzer to analyze the project
|
22
|
+
unless clang_analyze(analyze_params)
|
23
|
+
puts('ERROR : Failed to analyze project. Exiting ......')
|
24
|
+
return
|
25
|
+
end
|
26
|
+
|
27
|
+
unless generate_summary(analyze_params)
|
28
|
+
puts('ERROR : Failed to generate analysis summary. Exiting ......')
|
29
|
+
return
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
def self.prepare(params)
|
34
|
+
if params.nil?
|
35
|
+
analyze_params = nil
|
36
|
+
else
|
37
|
+
analyze_params = {}
|
38
|
+
|
39
|
+
params.all_keys.each do |item|
|
40
|
+
unless params[item].nil? || params[item].empty?
|
41
|
+
analyze_params[item] = params[item]
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
# The default output_format is 'plist-html'
|
46
|
+
unless analyze_params.key?(:output_format)
|
47
|
+
analyze_params[:output_format] = 'plist-html'
|
48
|
+
end
|
49
|
+
# For CI/CD convenience, this action only supports 'plist' or 'plist-html' as output_format
|
50
|
+
unless analyze_params[:output_format].include?('plist')
|
51
|
+
return nil
|
52
|
+
end
|
53
|
+
|
54
|
+
# The default output_dir is './static_analysis'
|
55
|
+
unless analyze_params.key?(:output_dir)
|
56
|
+
analyze_params[:output_dir] = './static_analysis'
|
57
|
+
end
|
58
|
+
FileUtils.mkdir_p(analyze_params[:output_dir]) unless File.exist?(analyze_params[:output_dir])
|
59
|
+
analyze_params[:output_compile_commands] = "#{analyze_params[:output_dir]}/compile_commands.json"
|
60
|
+
|
61
|
+
analyze_params[:output_report_dir] = "#{analyze_params[:output_dir]}/report-#{Time.new.strftime('%Y%m%d%H%M%S')}"
|
62
|
+
FileUtils.mkdir_p(analyze_params[:output_report_dir]) unless File.exist?(analyze_params[:output_report_dir])
|
63
|
+
|
64
|
+
analyze_params[:output_summary_file] = 'clang_analyzer_summary.xml'
|
65
|
+
end
|
66
|
+
|
67
|
+
analyze_params
|
68
|
+
end
|
69
|
+
|
70
|
+
def self.xcode_build(params)
|
71
|
+
puts('Step : start xcodebuild ......')
|
72
|
+
|
73
|
+
cmd_line = []
|
74
|
+
|
75
|
+
# xcodebuild executive
|
76
|
+
cmd_line << params.key?(:xcodebuild) ? params[:xcodebuild] : 'xcodebuild'
|
77
|
+
|
78
|
+
# -project
|
79
|
+
if params.key?(:project)
|
80
|
+
cmd_line << "-project #{params[:project]}"
|
81
|
+
else
|
82
|
+
# -workspace
|
83
|
+
if params.key?(:workspace)
|
84
|
+
cmd_line << "-workspace #{params[:workspace]}"
|
85
|
+
end
|
86
|
+
|
87
|
+
# -scheme
|
88
|
+
if params.key?(:scheme)
|
89
|
+
cmd_line << "-scheme #{params[:scheme]}"
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
93
|
+
# xcode configuration
|
94
|
+
if params.key?(:configuration)
|
95
|
+
cmd_line << "-configuration #{params[:configuration]}"
|
96
|
+
end
|
97
|
+
|
98
|
+
# build command
|
99
|
+
cmd_line << 'clean'
|
100
|
+
cmd_line << 'build'
|
101
|
+
|
102
|
+
cmd_line << '|'
|
103
|
+
|
104
|
+
# xcpretty executive
|
105
|
+
cmd_line << params.key?(:xcpretty) ? params[:xcpretty] : 'xcpretty'
|
106
|
+
|
107
|
+
cmd_line << '-r json-compilation-database'
|
108
|
+
|
109
|
+
cmd_line << "--output #{params[:output_compile_commands]}"
|
110
|
+
|
111
|
+
cmd = cmd_line.join(' ')
|
112
|
+
puts("running : #{cmd}")
|
113
|
+
|
114
|
+
stdout = `#{cmd}`
|
115
|
+
# puts stdout
|
116
|
+
|
117
|
+
($?.to_i.zero? && stdout.index('clang: error: ').nil? && stdout.index('BUILD FAILED').nil?)
|
118
|
+
end
|
119
|
+
|
120
|
+
def self.clang_analyze(params)
|
121
|
+
puts('Step : start clang analyzer ......')
|
122
|
+
|
123
|
+
compile_cmds = File.read(params[:output_compile_commands])
|
124
|
+
compile_cmds_json = JSON.parse(compile_cmds)
|
125
|
+
|
126
|
+
compile_cmds_json.each do |cmd|
|
127
|
+
analyzer_cmd = parse_compile_command(params, cmd)
|
128
|
+
puts(analyzer_cmd)
|
129
|
+
`#{analyzer_cmd}`
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
def self.generate_summary(params)
|
134
|
+
puts('Step : start generating analysis summary ......')
|
135
|
+
|
136
|
+
plist_files = []
|
137
|
+
Dir.foreach(params[:output_report_dir]) do |file|
|
138
|
+
if File.extname(file) == '.plist'
|
139
|
+
plist_files << file
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
if plist_files.size.zero?
|
144
|
+
puts('ERROR : Cannot find plist files. Other formats are not fully supported now.')
|
145
|
+
return false
|
146
|
+
end
|
147
|
+
|
148
|
+
issues = []
|
149
|
+
plist_files.each { |plist_file| parse_plist("#{params[:output_report_dir]}/#{plist_file}", issues) }
|
150
|
+
|
151
|
+
ordered_issues = parse_issues(issues)
|
152
|
+
builder = Nokogiri::XML::Builder.new do |xml|
|
153
|
+
xml.IssueList do
|
154
|
+
ordered_issues.values.each do |issue_entry|
|
155
|
+
issue_entry.each do |issue|
|
156
|
+
xml.Issue do
|
157
|
+
xml.Checker(issue['checker'])
|
158
|
+
xml.Category(issue['category'])
|
159
|
+
xml.Type(issue['type'])
|
160
|
+
xml.Message(issue['message'])
|
161
|
+
xml.Source(issue['source_file'])
|
162
|
+
xml.Line(issue['line'])
|
163
|
+
xml.Col(issue['col'])
|
164
|
+
xml.Context(issue['context'])
|
165
|
+
xml.ContextKind(issue['context_kind'])
|
166
|
+
xml.HtmlAttachments do
|
167
|
+
issue['html_details'].each do |html|
|
168
|
+
xml.Attachment(html)
|
169
|
+
end
|
170
|
+
end
|
171
|
+
end
|
172
|
+
end
|
173
|
+
end
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
File.open("#{params[:output_report_dir]}/#{params[:output_summary_file]}", 'w') { |file| file.write(builder.to_xml) }
|
178
|
+
|
179
|
+
true
|
180
|
+
end
|
181
|
+
|
182
|
+
def self.parse_compile_command(params, cmd_json)
|
183
|
+
cmd = cmd_json['command']
|
184
|
+
target_file = "#{cmd_json['directory']}/#{cmd_json['file']}"
|
185
|
+
cmd_array = cmd.split(' ')
|
186
|
+
|
187
|
+
analyzer_cmd_array = []
|
188
|
+
|
189
|
+
# Use the specified clang if necessary
|
190
|
+
analyzer_cmd_array << (params.key?(:clang) ? params[:clang] : cmd_array[0])
|
191
|
+
cmd_array.shift
|
192
|
+
|
193
|
+
subsequent = false
|
194
|
+
cmd_array.each do |item|
|
195
|
+
if subsequent
|
196
|
+
subsequent = !item.start_with?('-')
|
197
|
+
end
|
198
|
+
|
199
|
+
if subsequent
|
200
|
+
# Discard
|
201
|
+
else
|
202
|
+
if item.start_with?('-W') # warning
|
203
|
+
# Discard '-W'
|
204
|
+
subsequent = false
|
205
|
+
elsif item.start_with?('-c', '-o', '-index-store-path')
|
206
|
+
# Discard '-c', '-o', '-index-store-path'
|
207
|
+
subsequent = true
|
208
|
+
else
|
209
|
+
analyzer_cmd_array << item
|
210
|
+
subsequent = false
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
214
|
+
|
215
|
+
# Suppress all warnings
|
216
|
+
analyzer_cmd_array << '-w'
|
217
|
+
|
218
|
+
analyzer_cmd_array << '--analyze'
|
219
|
+
|
220
|
+
# Set the output format of clang analyzer
|
221
|
+
analyzer_cmd_array << "-Xclang -analyzer-output=#{params[:output_format]}"
|
222
|
+
|
223
|
+
# Set the checker sets of clang analyzer
|
224
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=core'
|
225
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=cplusplus'
|
226
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=deadcode'
|
227
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=nullability'
|
228
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=osx'
|
229
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=security'
|
230
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=unix'
|
231
|
+
analyzer_cmd_array << '-Xclang -analyzer-checker=valist'
|
232
|
+
analyzer_cmd_array << '-Xclang -analyzer-disable-checker=apiModeling'
|
233
|
+
analyzer_cmd_array << '-Xclang -analyzer-disable-checker=optin'
|
234
|
+
analyzer_cmd_array << '-Xclang -analyzer-disable-checker=alpha'
|
235
|
+
|
236
|
+
# Set the target file to be analyzed
|
237
|
+
analyzer_cmd_array << target_file
|
238
|
+
|
239
|
+
# Set the output file
|
240
|
+
report_file = File.basename(target_file, '.*')
|
241
|
+
if params[:output_format].eql?('plist') || params[:output_format].eql?('plist-html')
|
242
|
+
report_file += '.plist'
|
243
|
+
elsif params[:output_format].eql?('html')
|
244
|
+
end
|
245
|
+
analyzer_cmd_array << "-o #{params[:output_report_dir]}/#{report_file}"
|
246
|
+
|
247
|
+
analyzer_cmd_array.join(' ')
|
248
|
+
end
|
249
|
+
|
250
|
+
def self.parse_plist(plist_path, issues)
|
251
|
+
plist = File.open(plist_path) { |f| Plist.parse_xml(f) }
|
252
|
+
if plist.nil?
|
253
|
+
return
|
254
|
+
end
|
255
|
+
|
256
|
+
# The corresponding source file of the plist file
|
257
|
+
# Noted : the length of 'files' will always be 1 now
|
258
|
+
plist_files = plist['files']
|
259
|
+
if plist_files.nil? || plist_files.size.zero?
|
260
|
+
return
|
261
|
+
end
|
262
|
+
|
263
|
+
plist_diagnostics = plist['diagnostics']
|
264
|
+
if plist_diagnostics.nil? || plist_diagnostics.size.zero?
|
265
|
+
return
|
266
|
+
end
|
267
|
+
|
268
|
+
# Analyze output diagnostics
|
269
|
+
plist_diagnostics.each do |item|
|
270
|
+
issue = {}
|
271
|
+
issue['checker'] = item['check_name']
|
272
|
+
issue['category'] = item['category']
|
273
|
+
issue['type'] = item['type']
|
274
|
+
issue['message'] = item['description']
|
275
|
+
issue['source_file'] = plist_files[item['location']['file']]
|
276
|
+
issue['line'] = item['location']['line']
|
277
|
+
issue['col'] = item['location']['col']
|
278
|
+
issue['context'] = item['issue_context']
|
279
|
+
issue['context_kind'] = item['issue_context_kind']
|
280
|
+
issue['html_details'] = item['HTMLDiagnostics_files']
|
281
|
+
|
282
|
+
issues << issue
|
283
|
+
end
|
284
|
+
end
|
285
|
+
|
286
|
+
def self.parse_issues(issues)
|
287
|
+
ordered_issues = {}
|
288
|
+
|
289
|
+
if issues.nil? || issues.size.zero?
|
290
|
+
return ordered_issues
|
291
|
+
end
|
292
|
+
|
293
|
+
issues.each do |issue|
|
294
|
+
issue_key = issue['checker']
|
295
|
+
|
296
|
+
unless ordered_issues.key?(issue_key)
|
297
|
+
ordered_issues[issue_key] = []
|
298
|
+
end
|
299
|
+
ordered_issues[issue_key] << issue
|
300
|
+
end
|
301
|
+
|
302
|
+
ordered_issues
|
303
|
+
end
|
304
|
+
|
305
|
+
def self.description
|
306
|
+
'Analyze source codes with clang analyzer'
|
307
|
+
end
|
308
|
+
|
309
|
+
def self.authors
|
310
|
+
['squirrel-explorer']
|
311
|
+
end
|
312
|
+
|
313
|
+
def self.return_value
|
314
|
+
# If your method provides a return value, you can describe here what it does
|
315
|
+
end
|
316
|
+
|
317
|
+
def self.details
|
318
|
+
# Optional:
|
319
|
+
'Run clang analyzer to analyze your source codes. We can help you find potential bugs or security risks in advance.'
|
320
|
+
end
|
321
|
+
|
322
|
+
def self.available_options
|
323
|
+
[
|
324
|
+
FastlaneCore::ConfigItem.new(key: :project,
|
325
|
+
description: 'The xcode project',
|
326
|
+
optional: true,
|
327
|
+
type: String),
|
328
|
+
FastlaneCore::ConfigItem.new(key: :workspace,
|
329
|
+
description: 'The xcode workspace',
|
330
|
+
optional: true,
|
331
|
+
type: String),
|
332
|
+
FastlaneCore::ConfigItem.new(key: :scheme,
|
333
|
+
description: 'The scheme of xcode project',
|
334
|
+
optional: true,
|
335
|
+
type: String),
|
336
|
+
FastlaneCore::ConfigItem.new(key: :configuration,
|
337
|
+
description: 'The configuration of xcode project',
|
338
|
+
optional: false,
|
339
|
+
type: String),
|
340
|
+
FastlaneCore::ConfigItem.new(key: :output_format,
|
341
|
+
description: 'The output file format of static analysis',
|
342
|
+
optional: true,
|
343
|
+
type: String),
|
344
|
+
FastlaneCore::ConfigItem.new(key: :output_dir,
|
345
|
+
description: 'The output directory of static analysis',
|
346
|
+
optional: true,
|
347
|
+
type: String),
|
348
|
+
FastlaneCore::ConfigItem.new(key: :xcodebuild,
|
349
|
+
description: 'User-specified xcodebuild path',
|
350
|
+
optional: true,
|
351
|
+
type: String),
|
352
|
+
FastlaneCore::ConfigItem.new(key: :xcpretty,
|
353
|
+
description: 'User-specified xcpretty path',
|
354
|
+
optional: true,
|
355
|
+
type: String),
|
356
|
+
FastlaneCore::ConfigItem.new(key: :clang,
|
357
|
+
description: 'User-specified clang path',
|
358
|
+
optional: true,
|
359
|
+
type: String)
|
360
|
+
]
|
361
|
+
end
|
362
|
+
|
363
|
+
def self.is_supported?(platform)
|
364
|
+
[:ios].include?(platform)
|
365
|
+
end
|
366
|
+
end
|
367
|
+
end
|
368
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'fastlane_core/ui/ui'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
|
5
|
+
|
6
|
+
module Helper
|
7
|
+
class ClangToolsHelper
|
8
|
+
# class methods that you define here become available in your action
|
9
|
+
# as `Helper::ClangToolsHelper.your_method`
|
10
|
+
#
|
11
|
+
def self.show_message
|
12
|
+
UI.message('Hello from the clang_tools plugin helper!')
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
metadata
ADDED
@@ -0,0 +1,174 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fastlane-plugin-clang_tools
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- squirrel-explorer
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: pry
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec_junit_formatter
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop-require_tools
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: simplecov
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: fastlane
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 2.149.1
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 2.149.1
|
139
|
+
description:
|
140
|
+
email: 'xvider.zx # gmail.com'
|
141
|
+
executables: []
|
142
|
+
extensions: []
|
143
|
+
extra_rdoc_files: []
|
144
|
+
files:
|
145
|
+
- LICENSE
|
146
|
+
- README.md
|
147
|
+
- lib/fastlane/plugin/clang_tools.rb
|
148
|
+
- lib/fastlane/plugin/clang_tools/actions/clang_analyzer_action.rb
|
149
|
+
- lib/fastlane/plugin/clang_tools/helper/clang_analyzer_helper.rb
|
150
|
+
- lib/fastlane/plugin/clang_tools/version.rb
|
151
|
+
homepage: https://github.com/squirrel-explorer/fastlane-plugin-clang_tools
|
152
|
+
licenses:
|
153
|
+
- Apache 2.0
|
154
|
+
metadata: {}
|
155
|
+
post_install_message:
|
156
|
+
rdoc_options: []
|
157
|
+
require_paths:
|
158
|
+
- lib
|
159
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
160
|
+
requirements:
|
161
|
+
- - ">="
|
162
|
+
- !ruby/object:Gem::Version
|
163
|
+
version: '0'
|
164
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
165
|
+
requirements:
|
166
|
+
- - ">="
|
167
|
+
- !ruby/object:Gem::Version
|
168
|
+
version: '0'
|
169
|
+
requirements: []
|
170
|
+
rubygems_version: 3.1.2
|
171
|
+
signing_key:
|
172
|
+
specification_version: 4
|
173
|
+
summary: A series of clang-based tools for CI/CD.
|
174
|
+
test_files: []
|