knife-role-spaghetti 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +22 -0
- data/.travis.yml +7 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +92 -0
- data/Rakefile +33 -0
- data/features/cli.feature +66 -0
- data/features/graphing.feature +76 -0
- data/features/support/env.rb +14 -0
- data/knife-role-spaghetti.gemspec +30 -0
- data/lib/chef/knife/spaghetti.rb +101 -0
- data/lib/knife-role-spaghetti.rb +3 -0
- metadata +172 -0
data/.gitignore
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.chef
|
5
|
+
.config
|
6
|
+
.rvmrc
|
7
|
+
.DS_Store
|
8
|
+
coverage
|
9
|
+
Gemfile.lock
|
10
|
+
InstalledFiles
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
18
|
+
|
19
|
+
# YARD artifacts
|
20
|
+
.yardoc
|
21
|
+
_yardoc
|
22
|
+
doc/
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
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,92 @@
|
|
1
|
+
# knife-role-spaghetti [![Build Status](https://secure.travis-ci.org/miketheman/knife-role-spaghetti.png?branch=master)](http://travis-ci.org/miketheman/knife-role-spaghetti)
|
2
|
+
|
3
|
+
Knife plugin for [Chef][chef] to draw dependency graphs for roles that have become spaghetti.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
#### Requirements
|
8
|
+
|
9
|
+
This plugin requires on [Graphviz][graphviz], and should be installed prior to
|
10
|
+
installing the plugin.
|
11
|
+
|
12
|
+
Graphviz may be obtained through a variety of methods. On OSX an easy method is
|
13
|
+
via [Homebrew][homebrew]:
|
14
|
+
|
15
|
+
$ brew install graphviz
|
16
|
+
|
17
|
+
### Gem install, via RubyGems:
|
18
|
+
|
19
|
+
$ gem install knife-role-spaghetti
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
**NOTE:** Ensure that your `knife.rb` has the `role_path` setting configured.
|
24
|
+
|
25
|
+
Since this is a [Knife][knife] plugin, execution should be performed in your Chef repository.
|
26
|
+
|
27
|
+
Execute:
|
28
|
+
|
29
|
+
$ knife role spaghetti
|
30
|
+
|
31
|
+
with no arguments should result in a new file named `role-spaghetti.png` in your
|
32
|
+
repo root.
|
33
|
+
|
34
|
+
$ knife role spaghetti "/tmp/someotherfilename.png"
|
35
|
+
|
36
|
+
will place the file in the specified location.
|
37
|
+
|
38
|
+
Execute `knife role spaghetti -h` for more options.
|
39
|
+
|
40
|
+
## Examples
|
41
|
+
From a [sample role][sample role jt], courtesy of @jtimberman, along with one from the [Opscode Wiki][sample role wiki], plus one more cyclic role model, produces this image:
|
42
|
+
|
43
|
+
![Sample Roles][sample roles]
|
44
|
+
|
45
|
+
(full resolution [here](http://cl.ly/image/1C0Q3p0y093s))
|
46
|
+
|
47
|
+
Running through the neato renderer (with the `-N` switch) produces this image:
|
48
|
+
|
49
|
+
![Sample Roles Neato][sample roles neato]
|
50
|
+
|
51
|
+
(full resolution [here](http://cl.ly/image/2s340G0x3d33)
|
52
|
+
|
53
|
+
## Contributing
|
54
|
+
1. Fork it
|
55
|
+
1. Create your feature branch (`git checkout -b my-new-feature`)
|
56
|
+
1. Test your changes (`rake test`)
|
57
|
+
1. Commit your changes (`git commit -am 'Added some feature'`)
|
58
|
+
1. Push to the branch (`git push origin my-new-feature`)
|
59
|
+
1. Create new Pull Request
|
60
|
+
|
61
|
+
[chef]: http://www.opscode.com/chef/
|
62
|
+
[graphviz]: http://www.graphviz.org/
|
63
|
+
[homebrew]: http://mxcl.github.com/homebrew/
|
64
|
+
[knife]: http://wiki.opscode.com/display/chef/Knife
|
65
|
+
[sample role jt]: https://gist.github.com/858903
|
66
|
+
[sample role wiki]: http://wiki.opscode.com/display/chef/Roles#Roles-TheRubyDSL
|
67
|
+
[sample roles]: http://f.cl.ly/items/0w3r0k1I291g3x230m3y/rsz_sample-roles.png "Sample Roles"
|
68
|
+
[sample roles neato]: http://f.cl.ly/items/370L0z3L2U0l341Q0f2k/rsz_sample-roles-neato.png "Sample Roles - neato"
|
69
|
+
|
70
|
+
## Changelog
|
71
|
+
|
72
|
+
### v0.0.1
|
73
|
+
* Initial commit
|
74
|
+
|
75
|
+
|
76
|
+
## License
|
77
|
+
|
78
|
+
Author:: Mike Fiedler (<miketheman@gmail.com>)
|
79
|
+
Copyright:: Copyright (c) 2012 Mike Fiedler
|
80
|
+
License:: Apache License, Version 2.0
|
81
|
+
|
82
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
83
|
+
you may not use this file except in compliance with the License.
|
84
|
+
You may obtain a copy of the License at
|
85
|
+
|
86
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
87
|
+
|
88
|
+
Unless required by applicable law or agreed to in writing, software
|
89
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
90
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
91
|
+
See the License for the specific language governing permissions and
|
92
|
+
limitations under the License.
|
data/Rakefile
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
require 'bundler/gem_tasks'
|
3
|
+
|
4
|
+
task :test => [:tailor, :features]
|
5
|
+
|
6
|
+
task :default => :test
|
7
|
+
|
8
|
+
# https://github.com/turboladen/tailor
|
9
|
+
require 'tailor/rake_task'
|
10
|
+
Tailor::RakeTask.new do |task|
|
11
|
+
task.file_set('lib/**/*.rb', 'code')
|
12
|
+
end
|
13
|
+
|
14
|
+
require 'cucumber'
|
15
|
+
require 'cucumber/rake/task'
|
16
|
+
Cucumber::Rake::Task.new(:features) do |t|
|
17
|
+
t.cucumber_opts = ['features', '-x']
|
18
|
+
t.cucumber_opts += ['--format progress']
|
19
|
+
end
|
20
|
+
|
21
|
+
# File lib/tasks/notes.rake
|
22
|
+
desc "Find notes in code"
|
23
|
+
task :notes do
|
24
|
+
puts `grep --exclude=Rakefile -r 'OPTIMIZE:\\|FIXME:\\|TODO:' .`
|
25
|
+
end
|
26
|
+
|
27
|
+
# Clean up any artefacts
|
28
|
+
desc "Clean up dev environment cruft like tmp and packages"
|
29
|
+
task :clean do
|
30
|
+
%w{pkg tmp}.each do |subdir|
|
31
|
+
FileUtils.rm_rf(subdir)
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
Feature: Ensure that the Command Line Interface works as designed
|
2
|
+
In order to create role graphs via CLI
|
3
|
+
As a Chef
|
4
|
+
I want to run the CLI with different arguments
|
5
|
+
|
6
|
+
Background:
|
7
|
+
Given a file named ".chef/knife.rb" with:
|
8
|
+
"""
|
9
|
+
role_path ["#{File.dirname(__FILE__)}/../roles"]
|
10
|
+
"""
|
11
|
+
And a file named "roles/webserver.rb" with:
|
12
|
+
"""
|
13
|
+
name "webserver"
|
14
|
+
description "Simple Web App"
|
15
|
+
run_list(
|
16
|
+
"recipe[apache2]"
|
17
|
+
)
|
18
|
+
"""
|
19
|
+
And I double `dot`
|
20
|
+
And I double `neato`
|
21
|
+
|
22
|
+
Scenario Outline: Running with Help flags produces the correct result
|
23
|
+
When I run `knife role spaghetti <HelpFlag>`
|
24
|
+
Then the output should contain:
|
25
|
+
"""
|
26
|
+
knife role spaghetti FILENAME [-G FORMAT [-N] ]
|
27
|
+
"""
|
28
|
+
And the exit status should be 1
|
29
|
+
Examples:
|
30
|
+
| HelpFlag |
|
31
|
+
| -h |
|
32
|
+
| --help |
|
33
|
+
|
34
|
+
Scenario: Running with no arguments produces the correct result
|
35
|
+
When I successfully run `knife role spaghetti`
|
36
|
+
Then the exit status should be 0
|
37
|
+
|
38
|
+
Scenario: Running with a filename succeeds
|
39
|
+
When I successfully run `knife role spaghetti webserver.png`
|
40
|
+
Then the exit status should be 0
|
41
|
+
|
42
|
+
Scenario Outline: Running with different flags succeeds
|
43
|
+
When I successfully run `knife role spaghetti <Filename> <Flag> <Format>`
|
44
|
+
Then the exit status should be 0
|
45
|
+
Examples:
|
46
|
+
| Filename | Flag | Format |
|
47
|
+
| "webserver-short.png" | -G | png |
|
48
|
+
| "webserver-long.png" | --graph-format | png |
|
49
|
+
| "webserver-short.dot" | -G | dot |
|
50
|
+
| "webserver-long.dot" | --graph-format | dot |
|
51
|
+
|
52
|
+
Scenario Outline: Running with neato switch succeeds
|
53
|
+
When I successfully run `knife role spaghetti <Filename> <Flag>`
|
54
|
+
Then the exit status should be 0
|
55
|
+
Examples:
|
56
|
+
| Filename | Flag |
|
57
|
+
| "webserver-short-neato.png" | -N |
|
58
|
+
| "webserver-long-neato.png" | --neato-graph |
|
59
|
+
|
60
|
+
Scenario: Running with no filename, the format flag and no format, should fail
|
61
|
+
When I run `knife role spaghetti -G`
|
62
|
+
Then the exit status should be 1
|
63
|
+
|
64
|
+
Scenario: Running with no filename, the format flag and no format, should fail
|
65
|
+
When I run `knife role spaghetti failfile.png -G`
|
66
|
+
Then the exit status should be 1
|
@@ -0,0 +1,76 @@
|
|
1
|
+
Feature: Graphing role dependencies works
|
2
|
+
In order to map out role dependencies to a graph
|
3
|
+
As a Chef
|
4
|
+
I want to run the plugin against a roles directory
|
5
|
+
|
6
|
+
Background:
|
7
|
+
Given I double `dot`
|
8
|
+
And I double `neato`
|
9
|
+
|
10
|
+
Scenario: Running against a knife.rb with undefined roles directory should fail
|
11
|
+
Given an empty file named ".chef/knife.rb"
|
12
|
+
When I run `knife role spaghetti`
|
13
|
+
Then the output should contain exactly:
|
14
|
+
"""
|
15
|
+
FATAL: No roles were found in role_path: /var/chef/roles
|
16
|
+
FATAL: Ensure that your knife.rb has the correct path.
|
17
|
+
|
18
|
+
"""
|
19
|
+
And the exit status should be 1
|
20
|
+
|
21
|
+
Scenario: Running against a directory with multiple roles succeeds
|
22
|
+
Given a file named ".chef/knife.rb" with:
|
23
|
+
"""
|
24
|
+
role_path ["#{File.dirname(__FILE__)}/../roles"]
|
25
|
+
"""
|
26
|
+
And a file named "roles/webserver.rb" with:
|
27
|
+
"""
|
28
|
+
name "webserver"
|
29
|
+
description "Simple Web App"
|
30
|
+
run_list(
|
31
|
+
"recipe[apache2]"
|
32
|
+
)
|
33
|
+
"""
|
34
|
+
And a file named "roles/database.rb" with:
|
35
|
+
"""
|
36
|
+
name "database"
|
37
|
+
description "Some database"
|
38
|
+
run_list(
|
39
|
+
"recipe[mysql]"
|
40
|
+
)
|
41
|
+
"""
|
42
|
+
When I successfully run `knife role spaghetti multirole.png`
|
43
|
+
Then the exit status should be 0
|
44
|
+
|
45
|
+
Scenario: Running against embedded roles succeeds
|
46
|
+
Given a file named ".chef/knife.rb" with:
|
47
|
+
"""
|
48
|
+
role_path ["#{File.dirname(__FILE__)}/../roles"]
|
49
|
+
"""
|
50
|
+
And a file named "roles/webserver.rb" with:
|
51
|
+
"""
|
52
|
+
name "webserver"
|
53
|
+
description "Simple Web App"
|
54
|
+
run_list(
|
55
|
+
"recipe[apache2]"
|
56
|
+
)
|
57
|
+
"""
|
58
|
+
And a file named "roles/database.rb" with:
|
59
|
+
"""
|
60
|
+
name "database"
|
61
|
+
description "Some database"
|
62
|
+
run_list(
|
63
|
+
"recipe[mysql]"
|
64
|
+
)
|
65
|
+
"""
|
66
|
+
And a file named "roles/appstack.rb" with:
|
67
|
+
"""
|
68
|
+
name "appstack"
|
69
|
+
description "Application stack"
|
70
|
+
run_list(
|
71
|
+
"role[database]",
|
72
|
+
"role[webserver]"
|
73
|
+
)
|
74
|
+
"""
|
75
|
+
When I successfully run `knife role spaghetti embedded.png`
|
76
|
+
Then the exit status should be 0
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Set up the environment for testing
|
2
|
+
require 'aruba/cucumber'
|
3
|
+
require 'aruba-doubles/cucumber'
|
4
|
+
|
5
|
+
# Before do
|
6
|
+
# @dirs = ["tmp/aruba"]
|
7
|
+
# end
|
8
|
+
|
9
|
+
After do |s|
|
10
|
+
# Tell Cucumber to quit after this scenario is done - if it failed.
|
11
|
+
# This is useful to inspect the 'tmp/aruba' directory before any other
|
12
|
+
# steps are executed and clear it out.
|
13
|
+
Cucumber.wants_to_quit = true if s.failed?
|
14
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
chef_version = ENV.key?('CHEF_VERSION') ? "= #{ENV['CHEF_VERSION']}" : ['~> 10.12.0']
|
3
|
+
require File.expand_path('../lib/knife-role-spaghetti', __FILE__)
|
4
|
+
|
5
|
+
Gem::Specification.new do |gem|
|
6
|
+
|
7
|
+
gem.name = 'knife-role-spaghetti'
|
8
|
+
gem.summary = %q{Cut through the Role spaghetti with a Knife, Chef.}
|
9
|
+
gem.description = %q{This knife plugin extends the `knife role` command.}
|
10
|
+
gem.version = KnifeRoleSpaghetti::VERSION
|
11
|
+
|
12
|
+
gem.files = `git ls-files`.split($\)
|
13
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
14
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
15
|
+
gem.require_paths = ['lib']
|
16
|
+
|
17
|
+
gem.add_dependency 'chef', chef_version
|
18
|
+
gem.add_dependency 'ruby-graphviz'
|
19
|
+
|
20
|
+
gem.add_development_dependency 'rake'
|
21
|
+
gem.add_development_dependency 'aruba'
|
22
|
+
gem.add_development_dependency 'aruba-doubles'
|
23
|
+
gem.add_development_dependency 'tailor' # https://github.com/turboladen/tailor
|
24
|
+
gem.add_development_dependency 'travis-lint'
|
25
|
+
|
26
|
+
gem.authors = ["Mike Fiedler"]
|
27
|
+
gem.email = ["miketheman@gmail.com"]
|
28
|
+
gem.homepage = "http://www.miketheman.net"
|
29
|
+
|
30
|
+
end
|
@@ -0,0 +1,101 @@
|
|
1
|
+
require 'chef/knife'
|
2
|
+
|
3
|
+
module KnifeRoleSpaghetti
|
4
|
+
class RoleSpaghetti < Chef::Knife
|
5
|
+
|
6
|
+
deps do
|
7
|
+
require 'chef/role'
|
8
|
+
require 'graphviz'
|
9
|
+
end
|
10
|
+
|
11
|
+
banner "knife role spaghetti FILENAME [-G FORMAT [-N] ]"
|
12
|
+
|
13
|
+
option :graphformat,
|
14
|
+
:short => "-G FORMAT",
|
15
|
+
:long => "--graph-format FORMAT",
|
16
|
+
:default => "png",
|
17
|
+
:boolean => false,
|
18
|
+
:description => "Format for dependency graph output [png|dot]"
|
19
|
+
|
20
|
+
option :neatograph,
|
21
|
+
:short => "-N",
|
22
|
+
:long => "--neato-graph",
|
23
|
+
:boolean => true,
|
24
|
+
:description => "Specify to render the graph in the neato engine"
|
25
|
+
|
26
|
+
def run
|
27
|
+
|
28
|
+
self.config = Chef::Config.merge!(config)
|
29
|
+
|
30
|
+
# OPTIMIZE: Maybe instead of a flag, infer the graph format from fileext?
|
31
|
+
|
32
|
+
# Parse the configuration options, provide defaults where needed
|
33
|
+
if config[:graphformat]
|
34
|
+
output_format = config[:graphformat].to_sym
|
35
|
+
else
|
36
|
+
output_format = :png
|
37
|
+
end
|
38
|
+
|
39
|
+
# Determine of a filename has been passed
|
40
|
+
if @name_args.size >= 1
|
41
|
+
filename = @name_args[0]
|
42
|
+
else
|
43
|
+
filename = "role-spaghetti.#{output_format}"
|
44
|
+
end
|
45
|
+
|
46
|
+
# If we can't find any roles, it's pointless to continue.
|
47
|
+
if Dir.glob(File.join(Chef::Config.role_path, '*.rb')).size == 0
|
48
|
+
ui.fatal("No roles were found in role_path: #{config[:role_path]}")
|
49
|
+
ui.fatal("Ensure that your knife.rb has the correct path.")
|
50
|
+
exit 1
|
51
|
+
end
|
52
|
+
|
53
|
+
g = GraphViz.new(:RoleDependencies, :type => :digraph,
|
54
|
+
:fontname => "Verdana", :fontsize => 20,
|
55
|
+
:label => "\n\n\nChef Role Dependencies\n",
|
56
|
+
:rankdir => "LR",
|
57
|
+
:overlap => "false",
|
58
|
+
:compound => "true"
|
59
|
+
)
|
60
|
+
|
61
|
+
# OPTIMIZE: Handle json files too
|
62
|
+
Dir.glob(File.join(Chef::Config.role_path, '*.rb')) do |rb_file|
|
63
|
+
role = Chef::Role.new
|
64
|
+
role.from_file(rb_file)
|
65
|
+
# OPTIMIZE: Handle environment run_lists
|
66
|
+
|
67
|
+
g.node[:shape] = "box"
|
68
|
+
g.node[:style] = "rounded"
|
69
|
+
g.node[:color] = "red"
|
70
|
+
role_node = g.add_nodes(role.name)
|
71
|
+
|
72
|
+
# This logic is to ensure that an embedded role doesn't change color
|
73
|
+
role.run_list.each do |rli|
|
74
|
+
|
75
|
+
if rli.role?
|
76
|
+
g.node[:shape] = "box"
|
77
|
+
g.node[:style] = "rounded"
|
78
|
+
g.node[:color] = "red"
|
79
|
+
else
|
80
|
+
g.node[:shape] = "component"
|
81
|
+
g.node[:color] = "blue"
|
82
|
+
end
|
83
|
+
|
84
|
+
rli_node = g.add_nodes(rli.name)
|
85
|
+
g.add_edges(role_node, rli_node)
|
86
|
+
end
|
87
|
+
|
88
|
+
end
|
89
|
+
|
90
|
+
# Let's write out the graph to a file
|
91
|
+
if config[:neatograph]
|
92
|
+
g.output(output_format => "#{filename}", :use => "neato")
|
93
|
+
else
|
94
|
+
# default to dot
|
95
|
+
g.output(output_format => "#{filename}")
|
96
|
+
end
|
97
|
+
|
98
|
+
ui.msg("A Role dependency graph has been written to #{filename}")
|
99
|
+
end #run end
|
100
|
+
end #class end
|
101
|
+
end #module end
|
metadata
ADDED
@@ -0,0 +1,172 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: knife-role-spaghetti
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Mike Fiedler
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-07-20 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: chef
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: 10.12.0
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 10.12.0
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: ruby-graphviz
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: rake
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: aruba
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ! '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
type: :development
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ! '>='
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: aruba-doubles
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ! '>='
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ! '>='
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0'
|
94
|
+
- !ruby/object:Gem::Dependency
|
95
|
+
name: tailor
|
96
|
+
requirement: !ruby/object:Gem::Requirement
|
97
|
+
none: false
|
98
|
+
requirements:
|
99
|
+
- - ! '>='
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
type: :development
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
none: false
|
106
|
+
requirements:
|
107
|
+
- - ! '>='
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
- !ruby/object:Gem::Dependency
|
111
|
+
name: travis-lint
|
112
|
+
requirement: !ruby/object:Gem::Requirement
|
113
|
+
none: false
|
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
|
+
none: false
|
122
|
+
requirements:
|
123
|
+
- - ! '>='
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '0'
|
126
|
+
description: This knife plugin extends the `knife role` command.
|
127
|
+
email:
|
128
|
+
- miketheman@gmail.com
|
129
|
+
executables: []
|
130
|
+
extensions: []
|
131
|
+
extra_rdoc_files: []
|
132
|
+
files:
|
133
|
+
- .gitignore
|
134
|
+
- .travis.yml
|
135
|
+
- Gemfile
|
136
|
+
- LICENSE
|
137
|
+
- README.md
|
138
|
+
- Rakefile
|
139
|
+
- features/cli.feature
|
140
|
+
- features/graphing.feature
|
141
|
+
- features/support/env.rb
|
142
|
+
- knife-role-spaghetti.gemspec
|
143
|
+
- lib/chef/knife/spaghetti.rb
|
144
|
+
- lib/knife-role-spaghetti.rb
|
145
|
+
homepage: http://www.miketheman.net
|
146
|
+
licenses: []
|
147
|
+
post_install_message:
|
148
|
+
rdoc_options: []
|
149
|
+
require_paths:
|
150
|
+
- lib
|
151
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
152
|
+
none: false
|
153
|
+
requirements:
|
154
|
+
- - ! '>='
|
155
|
+
- !ruby/object:Gem::Version
|
156
|
+
version: '0'
|
157
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
158
|
+
none: false
|
159
|
+
requirements:
|
160
|
+
- - ! '>='
|
161
|
+
- !ruby/object:Gem::Version
|
162
|
+
version: '0'
|
163
|
+
requirements: []
|
164
|
+
rubyforge_project:
|
165
|
+
rubygems_version: 1.8.24
|
166
|
+
signing_key:
|
167
|
+
specification_version: 3
|
168
|
+
summary: Cut through the Role spaghetti with a Knife, Chef.
|
169
|
+
test_files:
|
170
|
+
- features/cli.feature
|
171
|
+
- features/graphing.feature
|
172
|
+
- features/support/env.rb
|