danger-shroud 0.0.2 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/workflows/ci.yml +28 -0
- data/.github/workflows/publish.yml +31 -0
- data/.ruby-version +1 -0
- data/Gemfile.lock +27 -20
- data/LICENSE +201 -0
- data/README.md +71 -13
- data/danger-shroud.gemspec +5 -5
- data/images/bannerImage.png +0 -0
- data/lib/shroud/gem_version.rb +1 -1
- data/lib/shroud/plugin.rb +123 -22
- metadata +15 -13
- data/.travis.yml +0 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ef8bbfd7e32b3948a01570f48a893401eda640342e58fb4721c6da5dc66ea94e
|
4
|
+
data.tar.gz: 8b4d3599b8eb136074632beba3c18c900ffea7b9ebc0d75abcaf9b986724e0d9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: af7c215e0fbaf9a39a6d7af965e3f322bb0a49fe9703782df35f74b016b4c7d5e081f14a769c9c4a0c70d6c9c48036124982b93ef59f5556dff43dbfa219a548
|
7
|
+
data.tar.gz: 31bc8ee27909c4164b77b276d69f9c8d30d49fb3e0ee32a4d60c64774e588a6a2d5c1fb0e17d145bd7dbc8867213de7f753dc92d1fccdec4ebcb8f7c5e8094d6
|
@@ -0,0 +1,28 @@
|
|
1
|
+
name: CI
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
pull_request:
|
6
|
+
|
7
|
+
env:
|
8
|
+
RUBY_VERSION: 2.7.2
|
9
|
+
|
10
|
+
jobs:
|
11
|
+
test:
|
12
|
+
runs-on: ubuntu-latest
|
13
|
+
|
14
|
+
steps:
|
15
|
+
- name: Checkout
|
16
|
+
uses: actions/checkout@v2
|
17
|
+
|
18
|
+
- name: Configure Ruby
|
19
|
+
uses: ruby/setup-ruby@v1
|
20
|
+
with:
|
21
|
+
ruby-version: ${{ env.RUBY_VERSION }}
|
22
|
+
bundler-cache: true
|
23
|
+
|
24
|
+
- name: Run Unit Tests
|
25
|
+
run: bundle exec rake spec
|
26
|
+
|
27
|
+
- name: Run Linter
|
28
|
+
run: bundle exec danger plugins lint
|
@@ -0,0 +1,31 @@
|
|
1
|
+
name: Ruby Gem
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [ "master" ]
|
6
|
+
|
7
|
+
jobs:
|
8
|
+
build:
|
9
|
+
name: Build + Publish
|
10
|
+
runs-on: ubuntu-latest
|
11
|
+
permissions:
|
12
|
+
contents: read
|
13
|
+
packages: write
|
14
|
+
|
15
|
+
steps:
|
16
|
+
- uses: actions/checkout@v3
|
17
|
+
- name: Set up Ruby 2.6
|
18
|
+
uses: actions/setup-ruby@v1
|
19
|
+
with:
|
20
|
+
ruby-version: 2.6.x
|
21
|
+
|
22
|
+
- name: Publish to RubyGems
|
23
|
+
run: |
|
24
|
+
mkdir -p $HOME/.gem
|
25
|
+
touch $HOME/.gem/credentials
|
26
|
+
chmod 0600 $HOME/.gem/credentials
|
27
|
+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
28
|
+
gem build *.gemspec
|
29
|
+
gem push *.gem
|
30
|
+
env:
|
31
|
+
GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.7.2
|
data/Gemfile.lock
CHANGED
@@ -1,16 +1,17 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
danger-shroud (0.0.
|
4
|
+
danger-shroud (0.0.5)
|
5
5
|
danger-plugin-api (~> 1.0)
|
6
|
+
nokogiri
|
6
7
|
|
7
8
|
GEM
|
8
9
|
remote: https://rubygems.org/
|
9
10
|
specs:
|
10
|
-
addressable (2.
|
11
|
-
public_suffix (>= 2.0.2, <
|
11
|
+
addressable (2.8.0)
|
12
|
+
public_suffix (>= 2.0.2, < 5.0)
|
12
13
|
ast (2.4.0)
|
13
|
-
claide (1.0.
|
14
|
+
claide (1.0.3)
|
14
15
|
claide-plugins (0.9.2)
|
15
16
|
cork
|
16
17
|
nap
|
@@ -19,14 +20,14 @@ GEM
|
|
19
20
|
colored2 (3.1.2)
|
20
21
|
cork (0.3.0)
|
21
22
|
colored2 (~> 3.1)
|
22
|
-
danger (6.
|
23
|
+
danger (6.3.2)
|
23
24
|
claide (~> 1.0)
|
24
25
|
claide-plugins (>= 0.9.2)
|
25
26
|
colored2 (~> 3.1)
|
26
27
|
cork (~> 0.1)
|
27
28
|
faraday (~> 0.9)
|
28
29
|
faraday-http-cache (~> 2.0)
|
29
|
-
git (~> 1.
|
30
|
+
git (~> 1.6)
|
30
31
|
kramdown (~> 2.0)
|
31
32
|
kramdown-parser-gfm (~> 1.0)
|
32
33
|
no_proxy_fix
|
@@ -35,13 +36,14 @@ GEM
|
|
35
36
|
danger-plugin-api (1.0.0)
|
36
37
|
danger (> 2.0)
|
37
38
|
diff-lcs (1.3)
|
38
|
-
faraday (0.
|
39
|
+
faraday (0.17.3)
|
39
40
|
multipart-post (>= 1.2, < 3)
|
40
41
|
faraday-http-cache (2.0.0)
|
41
42
|
faraday (~> 0.8)
|
42
43
|
ffi (1.11.1)
|
43
44
|
formatador (0.2.5)
|
44
|
-
git (1.
|
45
|
+
git (1.11.0)
|
46
|
+
rchardet (~> 1.8)
|
45
47
|
guard (2.15.0)
|
46
48
|
formatador (>= 0.2.4)
|
47
49
|
listen (>= 2.7, < 4.0)
|
@@ -57,7 +59,8 @@ GEM
|
|
57
59
|
guard-compat (~> 1.1)
|
58
60
|
rspec (>= 2.99.0, < 4.0)
|
59
61
|
jaro_winkler (1.5.2)
|
60
|
-
kramdown (2.1
|
62
|
+
kramdown (2.3.1)
|
63
|
+
rexml
|
61
64
|
kramdown-parser-gfm (1.1.0)
|
62
65
|
kramdown (~> 2.0)
|
63
66
|
listen (3.0.7)
|
@@ -65,17 +68,19 @@ GEM
|
|
65
68
|
rb-inotify (>= 0.9.7)
|
66
69
|
lumberjack (1.0.13)
|
67
70
|
method_source (0.9.2)
|
68
|
-
mini_portile2 (2.
|
71
|
+
mini_portile2 (2.8.0)
|
69
72
|
multipart-post (2.1.1)
|
70
73
|
nap (1.1.0)
|
71
74
|
nenv (0.3.0)
|
72
75
|
no_proxy_fix (0.1.2)
|
73
|
-
nokogiri (1.
|
74
|
-
mini_portile2 (~> 2.
|
76
|
+
nokogiri (1.13.6)
|
77
|
+
mini_portile2 (~> 2.8.0)
|
78
|
+
racc (~> 1.4)
|
75
79
|
notiffany (0.1.1)
|
76
80
|
nenv (~> 0.1)
|
77
81
|
shellany (~> 0.0)
|
78
|
-
octokit (4.
|
82
|
+
octokit (4.18.0)
|
83
|
+
faraday (>= 0.9)
|
79
84
|
sawyer (~> 0.8.0, >= 0.5.3)
|
80
85
|
open4 (1.3.4)
|
81
86
|
parallel (1.17.0)
|
@@ -84,12 +89,15 @@ GEM
|
|
84
89
|
pry (0.12.2)
|
85
90
|
coderay (~> 1.1.0)
|
86
91
|
method_source (~> 0.9.0)
|
87
|
-
public_suffix (
|
92
|
+
public_suffix (4.0.6)
|
93
|
+
racc (1.6.0)
|
88
94
|
rainbow (3.0.0)
|
89
|
-
rake (
|
95
|
+
rake (13.0.3)
|
90
96
|
rb-fsevent (0.10.3)
|
91
97
|
rb-inotify (0.10.0)
|
92
98
|
ffi (~> 1.0)
|
99
|
+
rchardet (1.8.0)
|
100
|
+
rexml (3.2.5)
|
93
101
|
rspec (3.8.0)
|
94
102
|
rspec-core (~> 3.8.0)
|
95
103
|
rspec-expectations (~> 3.8.0)
|
@@ -119,23 +127,22 @@ GEM
|
|
119
127
|
unicode-display_width (~> 1.1, >= 1.1.1)
|
120
128
|
thor (0.20.3)
|
121
129
|
unicode-display_width (1.6.0)
|
122
|
-
yard (0.9.
|
130
|
+
yard (0.9.26)
|
123
131
|
|
124
132
|
PLATFORMS
|
125
133
|
ruby
|
126
134
|
|
127
135
|
DEPENDENCIES
|
128
|
-
bundler (~>
|
136
|
+
bundler (~> 2.2)
|
129
137
|
danger-shroud!
|
130
138
|
guard (~> 2.14)
|
131
139
|
guard-rspec (~> 4.7)
|
132
140
|
listen (= 3.0.7)
|
133
|
-
nokogiri
|
134
141
|
pry
|
135
|
-
rake (~>
|
142
|
+
rake (~> 13.0)
|
136
143
|
rspec (~> 3.4)
|
137
144
|
rubocop
|
138
145
|
yard
|
139
146
|
|
140
147
|
BUNDLED WITH
|
141
|
-
|
148
|
+
2.2.7
|
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 2020 Andrew Haisting
|
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
CHANGED
@@ -1,23 +1,81 @@
|
|
1
1
|
# danger-shroud
|
2
2
|
|
3
|
-
|
3
|
+
A danger plugin for enforcing code coverage coverage via a Kover or Jacoco coverage report.
|
4
|
+
|
5
|
+
![Shroud Banner Image](images/bannerImage.png)
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'danger-shroud'
|
13
|
+
```
|
14
|
+
|
15
|
+
## Usage Kover
|
16
|
+
|
17
|
+
Shroud depends on having a Kover coverage report generated for your project. For Android projects, [kotlinx-kover](https://github.com/Kotlin/kotlinx-kover) works well.
|
18
|
+
|
19
|
+
Running shroud with default values:
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
# Report coverage of modified files, fail if either total
|
23
|
+
# project coverage or any modified file's coverage is under 90%
|
24
|
+
shroud.reportKover 'Module Name', 'path/to/kover/report.xml'
|
25
|
+
```
|
26
|
+
|
27
|
+
Running shroud with custom coverage thresholds:
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
# Report coverage of modified files, fail if total project coverage is under 80%,
|
31
|
+
# or if any modified file's coverage is under 95%
|
32
|
+
shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95
|
33
|
+
```
|
34
|
+
|
35
|
+
Warn on builds instead of fail:
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
# Report coverage of modified files the same as the above example, except the
|
39
|
+
# builds will only warn instead of fail if below thresholds
|
40
|
+
shroud.reportKover 'Module Name', 'path/to/kover/report.xml', 80, 95, false
|
41
|
+
```
|
42
|
+
|
43
|
+
|
44
|
+
## Usage Jacoco
|
45
|
+
|
46
|
+
Shroud depends on having a Jacoco coverage report generated for your project. For Android projects, [jacoco-android-gradle-plugin](https://github.com/arturdm/jacoco-android-gradle-plugin) works well.
|
47
|
+
|
48
|
+
Running shroud with default values:
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
# Report coverage of modified files, fail if either total
|
52
|
+
# project coverage or any modified file's coverage is under 90%
|
53
|
+
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml'
|
54
|
+
```
|
55
|
+
|
56
|
+
Running shroud with custom coverage thresholds:
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
# Report coverage of modified files, fail if total project coverage is under 80%,
|
60
|
+
# or if any modified file's coverage is under 95%
|
61
|
+
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95
|
62
|
+
```
|
63
|
+
|
64
|
+
Warn on builds instead of fail:
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
# Report coverage of modified files the same as the above example, except the
|
68
|
+
# builds will only warn instead of fail if below thresholds
|
69
|
+
shroud.reportJacoco 'Module Name', 'path/to/jacoco/report.xml', 80, 95, false
|
70
|
+
```
|
71
|
+
|
4
72
|
|
5
|
-
## Usage
|
6
73
|
|
7
|
-
Methods and attributes from this plugin are available in
|
8
|
-
your `Dangerfile` under the `shroud` namespace.
|
9
74
|
|
10
75
|
## Development
|
11
76
|
|
12
77
|
1. Clone this repo
|
13
78
|
2. Run `bundle install` to setup dependencies.
|
14
79
|
3. Run `bundle exec rake spec` to run the tests.
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
- [ ] Write real README
|
19
|
-
- [ ] Add paramater for failing project threshold
|
20
|
-
- [ ] Add paramater for failing modified file threshold
|
21
|
-
- [ ] Add shroud to bridge
|
22
|
-
- [ ] Write tests
|
23
|
-
- [ ] Make public, released as a regular ol' gem
|
80
|
+
4. Use `bundle exec guard` to automatically have tests run as you make changes.
|
81
|
+
5. Make your changes.
|
data/danger-shroud.gemspec
CHANGED
@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
|
|
8
8
|
spec.version = Shroud::VERSION
|
9
9
|
spec.authors = ['andrewhaisting']
|
10
10
|
spec.email = ['ahaisting@gmail.com']
|
11
|
-
spec.description = %q{
|
12
|
-
spec.summary = %q{
|
13
|
-
spec.homepage = 'https://github.com/
|
11
|
+
spec.description = %q{Enforce Jacoco code coverage on CI.}
|
12
|
+
spec.summary = %q{A danger plugin for enforcing code coverage via a Jacoco coverage report.}
|
13
|
+
spec.homepage = 'https://github.com/livefront/livefront-shroud-android'
|
14
14
|
spec.license = 'MIT'
|
15
15
|
|
16
16
|
spec.files = `git ls-files`.split($/)
|
@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
|
|
21
21
|
spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
|
22
22
|
|
23
23
|
# General ruby development
|
24
|
-
spec.add_development_dependency 'bundler', '~>
|
25
|
-
spec.add_development_dependency 'rake', '~>
|
24
|
+
spec.add_development_dependency 'bundler', '~> 2.2'
|
25
|
+
spec.add_development_dependency 'rake', '~> 13.0'
|
26
26
|
|
27
27
|
# Testing support
|
28
28
|
spec.add_development_dependency 'rspec', '~> 3.4'
|
Binary file
|
data/lib/shroud/gem_version.rb
CHANGED
data/lib/shroud/plugin.rb
CHANGED
@@ -1,29 +1,130 @@
|
|
1
1
|
require 'nokogiri'
|
2
2
|
|
3
3
|
module Danger
|
4
|
-
|
5
|
-
#
|
4
|
+
|
5
|
+
# Parse a Kover or Jacoco report to enforce code coverage on CI. Results are passed out as a table in markdown.
|
6
|
+
#
|
7
|
+
# Shroud depends on having a Kover or Jacoco coverage report generated for your project.
|
8
|
+
#
|
9
|
+
#
|
10
|
+
# @example Running Shroud with default values for Kover
|
11
|
+
#
|
12
|
+
# # Report coverage of modified files, fail if either total project coverage
|
13
|
+
# # or any modified file's coverage is under 90%
|
14
|
+
# shroud.reportKover 'Project Name', 'path/to/kover/report.xml'
|
15
|
+
#
|
16
|
+
# @example Running Shroud with custom coverage thresholds for Kover
|
17
|
+
#
|
18
|
+
# # Report coverage of modified files, fail if total project coverage is under 80%,
|
19
|
+
# # or if any modified file's coverage is under 95%
|
20
|
+
# shroud.reportKover 'Project Name', 'path/to/kover/report.xml', 80, 95
|
21
|
+
#
|
22
|
+
# @example Warn on builds instead of fail for Kover
|
23
|
+
#
|
24
|
+
# # Report coverage of modified files the same as the above example, except the
|
25
|
+
# # builds will only warn instead of fail if below thresholds
|
26
|
+
# shroud.reportKover 'Project Name', 'path/to/kover/report.xml', 80, 95, false
|
6
27
|
#
|
7
|
-
#
|
8
|
-
# the public interface documented. Danger uses [YARD](http://yardoc.org/)
|
9
|
-
# for generating documentation from your plugin source, and you can verify
|
10
|
-
# by running `danger plugins lint` or `bundle exec rake spec`.
|
28
|
+
# @example Running Shroud with default values for Jacoco
|
11
29
|
#
|
12
|
-
#
|
30
|
+
# # Report coverage of modified files, fail if either total project coverage
|
31
|
+
# # or any modified file's coverage is under 90%
|
32
|
+
# shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml'
|
33
|
+
#
|
34
|
+
# @example Running Shroud with custom coverage thresholds for Jacoco
|
35
|
+
#
|
36
|
+
# # Report coverage of modified files, fail if total project coverage is under 80%,
|
37
|
+
# # or if any modified file's coverage is under 95%
|
38
|
+
# shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml', 80, 95
|
39
|
+
#
|
40
|
+
# @example Warn on builds instead of fail for Jacoco
|
41
|
+
#
|
42
|
+
# # Report coverage of modified files the same as the above example, except the
|
43
|
+
# # builds will only warn instead of fail if below thresholds
|
44
|
+
# shroud.reportJacoco 'Project Name', 'path/to/jacoco/report.xml', 80, 95, false
|
45
|
+
#
|
46
|
+
# @tags android, kover, jacoco, coverage
|
13
47
|
#
|
14
48
|
class DangerShroud < Plugin
|
15
49
|
|
16
|
-
#
|
17
|
-
#
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
50
|
+
# <b>DEPRECATED:</b> Please use <tt>reportJacoco</tt> or <tt>reportKover</tt> instead.
|
51
|
+
#
|
52
|
+
# Report coverage on diffed files, as well as overall coverage.
|
53
|
+
#
|
54
|
+
# @param [String] file
|
55
|
+
# file path to a Jacoco xml coverage report.
|
56
|
+
#
|
57
|
+
# @param [Integer] totalProjectThreshold
|
58
|
+
# defines the required percentage of total project coverage for a passing build.
|
59
|
+
# default 90.
|
60
|
+
#
|
61
|
+
# @param [Integer] modifiedFileThreshold
|
62
|
+
# defines the required percentage of files modified in a PR for a passing build.
|
63
|
+
# default 90.
|
64
|
+
#
|
65
|
+
# @param [Boolean] failIfUnderThreshold
|
66
|
+
# if true, will fail builds that are under the provided thresholds. if false, will only warn.
|
67
|
+
# default true.
|
68
|
+
#
|
69
|
+
# @return [void]
|
70
|
+
def report(file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
|
71
|
+
warn "[DEPRECATION] `report` is deprecated. Please use `reportJacoco` or `reportKover` instead."
|
72
|
+
reportJacoco('Project', file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
|
73
|
+
end
|
74
|
+
|
75
|
+
# Report coverage on diffed files, as well as overall coverage.
|
76
|
+
#
|
77
|
+
# @param [String] moduleName
|
78
|
+
# the display name of the project or module
|
79
|
+
#
|
80
|
+
# @param [String] file
|
81
|
+
# file path to a Jacoco xml coverage report.
|
82
|
+
#
|
83
|
+
# @param [Integer] totalProjectThreshold
|
84
|
+
# defines the required percentage of total project coverage for a passing build.
|
85
|
+
# default 90.
|
86
|
+
#
|
87
|
+
# @param [Integer] modifiedFileThreshold
|
88
|
+
# defines the required percentage of files modified in a PR for a passing build.
|
89
|
+
# default 90.
|
90
|
+
#
|
91
|
+
# @param [Boolean] failIfUnderThreshold
|
92
|
+
# if true, will fail builds that are under the provided thresholds. if false, will only warn.
|
93
|
+
# default true.
|
94
|
+
#
|
95
|
+
# @return [void]
|
96
|
+
def reportJacoco(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
|
97
|
+
internalReport('Jacoco', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
|
98
|
+
end
|
99
|
+
|
100
|
+
# Report coverage on diffed files, as well as overall coverage.
|
101
|
+
#
|
102
|
+
# @param [String] moduleName
|
103
|
+
# the display name of the project or module
|
104
|
+
#
|
105
|
+
# @param [String] file
|
106
|
+
# file path to a Kover xml coverage report.
|
107
|
+
#
|
108
|
+
# @param [Integer] totalProjectThreshold
|
109
|
+
# defines the required percentage of total project coverage for a passing build.
|
110
|
+
# default 90.
|
22
111
|
#
|
23
|
-
# @
|
24
|
-
|
112
|
+
# @param [Integer] modifiedFileThreshold
|
113
|
+
# defines the required percentage of files modified in a PR for a passing build.
|
114
|
+
# default 90.
|
115
|
+
#
|
116
|
+
# @param [Boolean] failIfUnderThreshold
|
117
|
+
# if true, will fail builds that are under the provided thresholds. if false, will only warn.
|
118
|
+
# default true.
|
119
|
+
#
|
120
|
+
# @return [void]
|
121
|
+
def reportKover(moduleName, file, totalProjectThreshold = 90, modifiedFileThreshold = 90, failIfUnderThreshold = true)
|
122
|
+
internalReport('Kover', moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
|
123
|
+
end
|
124
|
+
|
125
|
+
private def internalReport(reportType, moduleName, file, totalProjectThreshold, modifiedFileThreshold, failIfUnderThreshold)
|
25
126
|
raise "Please specify file name." if file.empty?
|
26
|
-
raise "No
|
127
|
+
raise "No #{reportType} xml report found at #{file}" unless File.exist? file
|
27
128
|
rawXml = File.read(file)
|
28
129
|
parsedXml = Nokogiri::XML.parse(rawXml)
|
29
130
|
totalInstructionCoverage = parsedXml.xpath("/report/counter[@type='INSTRUCTION']")
|
@@ -36,8 +137,8 @@ module Danger
|
|
36
137
|
touchedFileNames = @dangerfile.git.modified_files.map { |file| File.basename(file) }
|
37
138
|
touchedFileNames += @dangerfile.git.added_files.map { |file| File.basename(file) }
|
38
139
|
|
39
|
-
# used to later report files that were modified but not included in the
|
40
|
-
|
140
|
+
# used to later report files that were modified but not included in the report
|
141
|
+
fileNamesNotInReport = []
|
41
142
|
|
42
143
|
# hash for keeping track of coverage per filename: {filename => coverage percent}
|
43
144
|
touchedFilesHash = {}
|
@@ -54,16 +155,16 @@ module Danger
|
|
54
155
|
end
|
55
156
|
touchedFilesHash[touchedFileName] = (covered.to_f / (missed + covered)) * 100
|
56
157
|
else
|
57
|
-
|
158
|
+
fileNamesNotInReport << touchedFileName
|
58
159
|
end
|
59
160
|
end
|
60
161
|
|
61
162
|
puts "Here are unreported files"
|
62
|
-
puts
|
163
|
+
puts fileNamesNotInReport.to_s
|
63
164
|
puts "Here is the touched files coverage hash"
|
64
165
|
puts touchedFilesHash
|
65
166
|
|
66
|
-
output = "## 🧛
|
167
|
+
output = "## 🧛 #{moduleName} Code Coverage: **`#{'%.2f' % coveragePercent}%`**\n"
|
67
168
|
|
68
169
|
output << "### Coverage of Modified Files:\n"
|
69
170
|
output << "File | Coverage\n"
|
@@ -85,7 +186,7 @@ module Danger
|
|
85
186
|
end
|
86
187
|
|
87
188
|
output << "### Modified Files Not Found In Coverage Report:\n"
|
88
|
-
|
189
|
+
fileNamesNotInReport.sort.each do |unreportedFileName|
|
89
190
|
output << "#{unreportedFileName}\n"
|
90
191
|
end
|
91
192
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: danger-shroud
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- andrewhaisting
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-07-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: danger-plugin-api
|
@@ -30,28 +30,28 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: '
|
33
|
+
version: '2.2'
|
34
34
|
type: :development
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '2.2'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rake
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '13.0'
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
52
|
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '
|
54
|
+
version: '13.0'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: rspec
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -164,28 +164,32 @@ dependencies:
|
|
164
164
|
- - ">="
|
165
165
|
- !ruby/object:Gem::Version
|
166
166
|
version: '0'
|
167
|
-
description:
|
167
|
+
description: Enforce Jacoco code coverage on CI.
|
168
168
|
email:
|
169
169
|
- ahaisting@gmail.com
|
170
170
|
executables: []
|
171
171
|
extensions: []
|
172
172
|
extra_rdoc_files: []
|
173
173
|
files:
|
174
|
+
- ".github/workflows/ci.yml"
|
175
|
+
- ".github/workflows/publish.yml"
|
174
176
|
- ".gitignore"
|
175
|
-
- ".
|
177
|
+
- ".ruby-version"
|
176
178
|
- Gemfile
|
177
179
|
- Gemfile.lock
|
178
180
|
- Guardfile
|
181
|
+
- LICENSE
|
179
182
|
- README.md
|
180
183
|
- Rakefile
|
181
184
|
- danger-shroud.gemspec
|
185
|
+
- images/bannerImage.png
|
182
186
|
- lib/danger_plugin.rb
|
183
187
|
- lib/danger_shroud.rb
|
184
188
|
- lib/shroud/gem_version.rb
|
185
189
|
- lib/shroud/plugin.rb
|
186
190
|
- spec/shroud_spec.rb
|
187
191
|
- spec/spec_helper.rb
|
188
|
-
homepage: https://github.com/
|
192
|
+
homepage: https://github.com/livefront/livefront-shroud-android
|
189
193
|
licenses:
|
190
194
|
- MIT
|
191
195
|
metadata: {}
|
@@ -204,12 +208,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
204
208
|
- !ruby/object:Gem::Version
|
205
209
|
version: '0'
|
206
210
|
requirements: []
|
207
|
-
|
208
|
-
rubygems_version: 2.6.11
|
211
|
+
rubygems_version: 3.0.3.1
|
209
212
|
signing_key:
|
210
213
|
specification_version: 4
|
211
|
-
summary:
|
212
|
-
on your team's PRs.
|
214
|
+
summary: A danger plugin for enforcing code coverage via a Jacoco coverage report.
|
213
215
|
test_files:
|
214
216
|
- spec/shroud_spec.rb
|
215
217
|
- spec/spec_helper.rb
|