codeowner_validator 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +7 -0
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
  3. data/.github/ISSUE_TEMPLATE/config.yml +6 -0
  4. data/.github/ISSUE_TEMPLATE/feature_request.md +30 -0
  5. data/.github/pull_request_template.md +32 -0
  6. data/.github/workflows/cd.yml +53 -0
  7. data/.github/workflows/ci.yml +39 -0
  8. data/.gitignore +23 -0
  9. data/.rspec +4 -0
  10. data/.rubocop.yml +926 -0
  11. data/.ruby-gemset +1 -0
  12. data/.ruby-version +1 -0
  13. data/.vscode/launch.json +53 -0
  14. data/CHANGELOG.md +5 -0
  15. data/CODE_OF_CONDUCT.md +74 -0
  16. data/CONTRIBUTING.md +40 -0
  17. data/CONTRIBUTORS.md +3 -0
  18. data/Gemfile +20 -0
  19. data/LICENSE +205 -0
  20. data/NOTICE +13 -0
  21. data/README.md +160 -0
  22. data/Rakefile +8 -0
  23. data/bin/bundle-audit +29 -0
  24. data/bin/bundler-audit +29 -0
  25. data/bin/codeowner_validator +8 -0
  26. data/bin/rake +29 -0
  27. data/bin/rspec +29 -0
  28. data/bin/rubocop +29 -0
  29. data/codeowner_validator.gemspec +41 -0
  30. data/lib/codeowner_validator/cli/validator_cli.rb +64 -0
  31. data/lib/codeowner_validator/code_owners.rb +308 -0
  32. data/lib/codeowner_validator/common/command.rb +40 -0
  33. data/lib/codeowner_validator/common/logging.rb +86 -0
  34. data/lib/codeowner_validator/common/tasks/base.rb +62 -0
  35. data/lib/codeowner_validator/group/comment/error.rb +21 -0
  36. data/lib/codeowner_validator/group/comment/info.rb +21 -0
  37. data/lib/codeowner_validator/group/comment/verbose.rb +21 -0
  38. data/lib/codeowner_validator/group/comment/warn.rb +21 -0
  39. data/lib/codeowner_validator/group/comment.rb +55 -0
  40. data/lib/codeowner_validator/helpers/config_helper.rb +73 -0
  41. data/lib/codeowner_validator/helpers/utility_helper.rb +30 -0
  42. data/lib/codeowner_validator/lists/whitelist.rb +145 -0
  43. data/lib/codeowner_validator/tasks/duplicate_checker.rb +32 -0
  44. data/lib/codeowner_validator/tasks/file_exists_checker.rb +35 -0
  45. data/lib/codeowner_validator/tasks/missing_assignment_checker.rb +32 -0
  46. data/lib/codeowner_validator/tasks/syntax_checker.rb +32 -0
  47. data/lib/codeowner_validator/validator.rb +76 -0
  48. data/lib/codeowner_validator/version.rb +11 -0
  49. data/lib/codeowner_validator.rb +32 -0
  50. data/lib/codeowners/checker/group/line.rb +12 -0
  51. metadata +204 -0
data/.ruby-gemset ADDED
@@ -0,0 +1 @@
1
+ codeowner_validator
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-2.6
@@ -0,0 +1,53 @@
1
+ {
2
+ // Use IntelliSense to learn about possible attributes.
3
+ // Hover to view descriptions of existing attributes.
4
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5
+ "version": "0.2.0",
6
+ "configurations": [
7
+ {
8
+ "env": {
9
+ "RUBY_VERSION": "ruby-2.6.6",
10
+ "GEM_HOME": "${env:HOME}/.rvm/gems/ruby-2.6.6",
11
+ "GEM_PATH": "${env:HOME}/.rvm/gems/ruby-2.6.6:${env:HOME}/.rvm/gems/ruby-2.6.6@global",
12
+ "PATH": "${env:HOME}/.rvm/gems/ruby-2.6.6/bin:${env:HOME}/.rvm/gems/ruby-2.6.6@global/bin:${env:HOME}/.rvm/rubies/ruby-2.6.6/bin:${env:HOME}/.rvm/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
13
+ }
14
+ },
15
+ {
16
+ "name": "RSpec - all",
17
+ "type": "Ruby",
18
+ "request": "launch",
19
+ "cwd": "${workspaceRoot}",
20
+ "program": "${workspaceRoot}/bin/rspec",
21
+ "args": [
22
+ "--pattern",
23
+ "${workspaceRoot}/spec/**/*_spec.rb"
24
+ ]
25
+ },
26
+ {
27
+ "name": "RSpec - active spec file only",
28
+ "type": "Ruby",
29
+ "request": "launch",
30
+ "cwd": "${workspaceRoot}",
31
+ "program": "${workspaceRoot}/bin/rspec",
32
+ "args": [
33
+ "-I",
34
+ "${workspaceRoot}",
35
+ "${file}"
36
+ ]
37
+ },
38
+ {
39
+ "name": "Debug RSpec - open spec file",
40
+ "type": "Ruby",
41
+ "request": "launch",
42
+ "cwd": "${workspaceRoot}",
43
+ "useBundler": true,
44
+ "pathToBundler": "${env:HOME}/.rvm/rubies/ruby-2.6.6/bin/bundler",
45
+ "pathToRDebugIDE": "${env:HOME}/.rvm/gems/ruby-2.6.6@codeowner_validator/gems/ruby-debug-ide-0.7.2",
46
+ "debuggerPort": "1235",
47
+ "program": "${workspaceRoot}/bin/rspec",
48
+ "args": [
49
+ "${file}"
50
+ ]
51
+ }
52
+ ]
53
+ }
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # 0.1.0
2
+ Initial release
3
+
4
+ # 0.1.1
5
+ Fix homepage reference
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at greg.howdeshell@cerner.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,40 @@
1
+ # Contributing
2
+
3
+ Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a [github issue][1] or submit a pull request.
4
+
5
+ Before you contribute, please review these guidelines to help ensure a smooth process for everyone.
6
+
7
+ Thanks.
8
+
9
+ ## Issue Reporting
10
+
11
+ * Please browse our [existing issues][1] before logging new issues.
12
+ * Check that the issue has not already been fixed in the `master` branch.
13
+ * Open an issue with a descriptive title and a summary.
14
+ * Please be as clear and explicit as you can in your description of the problem.
15
+ * Please state the version of {technical dependencies} and `inspec_delta` you are using in the description.
16
+ * Include any relevant code in the issue summary.
17
+
18
+ ## Pull Requests
19
+
20
+ * Read [how to properly contribute to open source projects on Github][2].
21
+ * Fork the project.
22
+ * Use a feature branch.
23
+ * Write [good commit messages][3].
24
+ * Use the same coding conventions as the rest of the project.
25
+ * Commit locally and push to your fork until you are happy with your contribution.
26
+ * Make sure to add tests and verify all the tests are passing when merging upstream.
27
+ * Add an entry to the [Changelog][4] accordingly.
28
+ * Please add your name to the [CONTRIBUTORS.md][8] file. Adding your name to the [CONTRIBUTORS.md][8] file signifies agreement to all rights and reservations provided by the [License][5].
29
+ * [Squash related commits together][6].
30
+ * Open a [pull request][7].
31
+ * The pull request will be reviewed by the community and merged by the project committers.
32
+
33
+ [1]: https://github.com/cerner/inspec_delta/issues
34
+ [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
35
+ [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
36
+ [4]: ./CHANGELOG.md
37
+ [5]: ./LICENSE
38
+ [6]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
39
+ [7]: https://help.github.com/articles/using-pull-requests
40
+ [8]: ./CONTRIBUTORS.md
data/CONTRIBUTORS.md ADDED
@@ -0,0 +1,3 @@
1
+ Cerner Corporation
2
+
3
+ * Greg Howdeshell [@poloka](https://github.com/poloka)
data/Gemfile ADDED
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ gemspec
6
+
7
+ # build-time dependencies
8
+ gem 'bundler-audit'
9
+ gem 'irb', require: false
10
+ gem 'rake', '>= 12.0'
11
+ gem 'rspec', '~> 3.4'
12
+ gem 'rubocop', '~> 1.0', require: false
13
+ gem 'rubocop-performance', '~> 1.8', require: false
14
+ gem 'rubocop-rake', '~> 0.5', require: false
15
+ gem 'rubocop-rspec', '~> 2.1', require: false
16
+ gem 'simplecov', '~> 0.19', require: false
17
+
18
+ # debugging
19
+ gem 'debase', '~> 0.2.5.beta2'
20
+ gem 'ruby-debug-ide'
data/LICENSE ADDED
@@ -0,0 +1,205 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
203
+
204
+ This project includes rc4.rb, portions which are from the Ruby-RC4 library
205
+ and available under the MIT license. For details, see libraries/rc4.rb.
data/NOTICE ADDED
@@ -0,0 +1,13 @@
1
+ Copyright 2021 Cerner Innovation, Inc.
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,160 @@
1
+ # CODEOWNER Validator
2
+
3
+ ![CI](https://github.com/cerner/codeowner_validator/actions/workflows/ci.yml/badge.svg)
4
+
5
+ This library provides interactions with the GitHub CODEOWNERS file for performing validation tasks that include
6
+ * ownership checks
7
+ * valid syntax
8
+ * missing files
9
+ * duplicate patterns
10
+
11
+ ## Usage
12
+ The library has been designed in a manner that allows invocation by a consumer in one of two options. The first use case is through the command line
13
+ interface (CLI). This allows the consumer to execute a command on the terminal and output a report resulting from the validation tasks. The second use
14
+ case allows consumers direct consumption of the methods utilized for the validation tasks to allow for writing their own custom implementation on how
15
+ to generate a report.
16
+
17
+ ### Command Line Use Case
18
+ #### Installation
19
+
20
+ Add this line to your application's Gemfile:
21
+
22
+ ```ruby
23
+ gem 'codeowner_validator'
24
+ ```
25
+
26
+ And then execute:
27
+
28
+ $ bundle
29
+
30
+ Or install it yourself as:
31
+
32
+ $ gem install codeowner_validator
33
+
34
+ #### Execution
35
+ ```
36
+ codeowner_validator validate
37
+ ```
38
+
39
+ Execution of the validator is against a supplied repository folder location. The business logic for retrieving said repository is up to the consumer.
40
+ Upon execution of the validator, the repository location will be asked of the executor. You may enter an absolute location or you could supply a parameter
41
+ of `-p` or `--repo-path` to avoid the question in the console.
42
+
43
+ ```
44
+ codeowner_validator validate -p /Users/foo/special-repository
45
+ ```
46
+
47
+ ### Consumer Use Case
48
+ #### Installation
49
+
50
+ Add this line to your application's Gemfile:
51
+
52
+ ```ruby
53
+ gem 'codeowner_validator'
54
+ ```
55
+
56
+ And then execute:
57
+
58
+ $ bundle
59
+
60
+ #### Execution
61
+ ```ruby
62
+ require 'codeowner_validator'
63
+
64
+ code_owners = CodeownerValidator::CodeOwners.new(
65
+ repo_path: "/Users/poloka/application-config"
66
+ )
67
+
68
+ # return an array of patterns that have no files associated to them
69
+ code_owners.useless_pattern
70
+
71
+ # returns a list of files from the repository that do not have an owner assigned
72
+ code_owners.missing_assignments
73
+ ```
74
+
75
+ ### Whitelist
76
+ With some projects, not all files within the repository need assignments. In this case, a consumer may define a list of relative path
77
+ locations within the repository to be scanned for evaluation. There are a few options and any combination of these options may be used
78
+
79
+ #### 'CODEOWNERS_WHITELIST' file
80
+ If the initialization of the whitelist object is provided a repository path, the retrieval of the [pathspec][pathspec-ruby] will include
81
+ entries from the provided file. This file may reside in either the root repository location or within the .github folder.
82
+ ```
83
+ application-config/
84
+ ├── CODEOWNERS_WHITELIST
85
+ └── .github/
86
+ ├── CODEOWNERS
87
+ └── CODEOWNERS_WHITELIST
88
+ ```
89
+
90
+ #### '.gitignore' file
91
+ If the initialization of the whitelist object is provided a repository path, all entries from the .gitignore will be added as items to
92
+ exclude from ownership evaluations.
93
+
94
+ #### ENV['CODEOWNERS_WHITELIST']
95
+ This option of an environment variable 'CODEOWNERS_WHITELIST' with a comma separated string is allowed.
96
+
97
+ ```
98
+ CODEOWNERS_WHITELIST=config/subfolder_01,config/subfolder_02 codeowner_validator validate -p /Users/foo/special-repository
99
+ ```
100
+
101
+ # Building
102
+ This project is built using Ruby 2.6+, Rake and Bundler. RSpec is used for unit tests and SimpleCov
103
+ is utilized for test coverage. RuboCop is used to monitor the lint and style.
104
+
105
+ ## Setup
106
+
107
+ To setup the development workspace, run the following after checkout:
108
+
109
+ gem install bundler
110
+ bundle install
111
+
112
+ ## Tests
113
+
114
+ To run the RSpec tests, run the following:
115
+
116
+ bin/rspec
117
+
118
+ ## Lint
119
+
120
+ To analyze the project's style and lint, run the following:
121
+
122
+ bin/rubocop
123
+
124
+ ## Bundler Audit
125
+
126
+ To analyze the project's dependency vulnerabilities, run the following:
127
+
128
+ bin/bundle audit
129
+
130
+ # Availability
131
+
132
+ This RubyGem will be available on https://rubygems.org/.
133
+
134
+ # Communication
135
+
136
+ All questions, bugs, enhancements and pull requests can be submitted here, on GitHub via Issues.
137
+
138
+ # Contributing
139
+
140
+ See [CONTRIBUTING.md](CONTRIBUTING.md)
141
+
142
+ ## License
143
+
144
+ Copyright 2020 Cerner Innovation, Inc.
145
+
146
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
147
+
148
+     http://www.apache.org/licenses/LICENSE-2.0
149
+
150
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
151
+
152
+ ## Code of Conduct
153
+
154
+ Everyone interacting in the CodeownerValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
155
+
156
+ ## References
157
+ Shout-out to @jonatas and his project [codeowners-checker](https://github.com/toptal/codeowners-checker). The checker provided easy reusage which greatly reduced the
158
+ dependencies within this project.
159
+
160
+ [pathspec-ruby]: https://github.com/highb/pathspec-ruby
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec
data/bin/bundle-audit ADDED
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'bundle-audit' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ require "pathname"
12
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13
+ Pathname.new(__FILE__).realpath)
14
+
15
+ bundle_binstub = File.expand_path("../bundle", __FILE__)
16
+
17
+ if File.file?(bundle_binstub)
18
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
19
+ load(bundle_binstub)
20
+ else
21
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
23
+ end
24
+ end
25
+
26
+ require "rubygems"
27
+ require "bundler/setup"
28
+
29
+ load Gem.bin_path("bundler-audit", "bundle-audit")
data/bin/bundler-audit ADDED
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'bundler-audit' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ require "pathname"
12
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13
+ Pathname.new(__FILE__).realpath)
14
+
15
+ bundle_binstub = File.expand_path("../bundle", __FILE__)
16
+
17
+ if File.file?(bundle_binstub)
18
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
19
+ load(bundle_binstub)
20
+ else
21
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
23
+ end
24
+ end
25
+
26
+ require "rubygems"
27
+ require "bundler/setup"
28
+
29
+ load Gem.bin_path("bundler-audit", "bundler-audit")
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ $LOAD_PATH.unshift(File.join(File.basename(__FILE__), '..', 'lib'))
5
+
6
+ require 'codeowner_validator'
7
+
8
+ CodeownerValidator::CLI.start(ARGV)