chef-dk 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (142) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTING.md +192 -0
  3. data/LICENSE +201 -0
  4. data/README.md +198 -0
  5. data/Rakefile +18 -0
  6. data/bin/chef +25 -0
  7. data/lib/chef-dk.rb +19 -0
  8. data/lib/chef-dk/builtin_commands.rb +31 -0
  9. data/lib/chef-dk/chef_runner.rb +83 -0
  10. data/lib/chef-dk/cli.rb +135 -0
  11. data/lib/chef-dk/command/base.rb +71 -0
  12. data/lib/chef-dk/command/exec.rb +33 -0
  13. data/lib/chef-dk/command/gem.rb +47 -0
  14. data/lib/chef-dk/command/generate.rb +97 -0
  15. data/lib/chef-dk/command/generator_commands.rb +417 -0
  16. data/lib/chef-dk/command/shell_init.rb +80 -0
  17. data/lib/chef-dk/command/verify.rb +226 -0
  18. data/lib/chef-dk/commands_map.rb +115 -0
  19. data/lib/chef-dk/component_test.rb +142 -0
  20. data/lib/chef-dk/cookbook_metadata.rb +36 -0
  21. data/lib/chef-dk/cookbook_omnifetch.rb +29 -0
  22. data/lib/chef-dk/cookbook_profiler/git.rb +95 -0
  23. data/lib/chef-dk/cookbook_profiler/identifiers.rb +79 -0
  24. data/lib/chef-dk/cookbook_profiler/null_scm.rb +32 -0
  25. data/lib/chef-dk/exceptions.rb +46 -0
  26. data/lib/chef-dk/generator.rb +70 -0
  27. data/lib/chef-dk/helpers.rb +95 -0
  28. data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb +46 -0
  29. data/lib/chef-dk/policyfile/community_cookbook_source.rb +84 -0
  30. data/lib/chef-dk/policyfile/cookbook_sources.rb +20 -0
  31. data/lib/chef-dk/policyfile/cookbook_spec.rb +96 -0
  32. data/lib/chef-dk/policyfile/dsl.rb +148 -0
  33. data/lib/chef-dk/policyfile/null_cookbook_source.rb +37 -0
  34. data/lib/chef-dk/policyfile_compiler.rb +217 -0
  35. data/lib/chef-dk/policyfile_lock.rb +243 -0
  36. data/lib/chef-dk/shell_out.rb +36 -0
  37. data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile +3 -0
  38. data/lib/chef-dk/skeletons/code_generator/files/default/chefignore +96 -0
  39. data/lib/chef-dk/skeletons/code_generator/files/default/converge_spec.rb +9 -0
  40. data/lib/chef-dk/skeletons/code_generator/files/default/gitignore +16 -0
  41. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb +8 -0
  42. data/lib/chef-dk/skeletons/code_generator/metadata.rb +8 -0
  43. data/lib/chef-dk/skeletons/code_generator/recipes/app.rb +65 -0
  44. data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb +12 -0
  45. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb +50 -0
  46. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb +24 -0
  47. data/lib/chef-dk/skeletons/code_generator/recipes/lwrp.rb +23 -0
  48. data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb +9 -0
  49. data/lib/chef-dk/skeletons/code_generator/recipes/template.rb +32 -0
  50. data/lib/chef-dk/skeletons/code_generator/templates/default/README.md.erb +4 -0
  51. data/lib/chef-dk/skeletons/code_generator/templates/default/attribute.rb.erb +0 -0
  52. data/lib/chef-dk/skeletons/code_generator/templates/default/cookbook_file.erb +0 -0
  53. data/lib/chef-dk/skeletons/code_generator/templates/default/default_recipe.rb.erb +8 -0
  54. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb +16 -0
  55. data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb +8 -0
  56. data/lib/chef-dk/skeletons/code_generator/templates/default/provider.rb.erb +0 -0
  57. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb +0 -0
  58. data/lib/chef-dk/skeletons/code_generator/templates/default/resource.rb.erb +0 -0
  59. data/lib/chef-dk/skeletons/code_generator/templates/default/template.erb +0 -0
  60. data/lib/chef-dk/version.rb +20 -0
  61. data/spec/shared/setup_git_cookbooks.rb +53 -0
  62. data/spec/spec_helper.rb +32 -0
  63. data/spec/test_helpers.rb +59 -0
  64. data/spec/unit/chef_runner_spec.rb +70 -0
  65. data/spec/unit/cli_spec.rb +151 -0
  66. data/spec/unit/command/base_spec.rb +88 -0
  67. data/spec/unit/command/exec_spec.rb +123 -0
  68. data/spec/unit/command/generate_spec.rb +102 -0
  69. data/spec/unit/command/generator_commands_spec.rb +504 -0
  70. data/spec/unit/command/shell_init_spec.rb +109 -0
  71. data/spec/unit/command/verify_spec.rb +311 -0
  72. data/spec/unit/commands_map_spec.rb +57 -0
  73. data/spec/unit/component_test_spec.rb +126 -0
  74. data/spec/unit/cookbook_metadata_spec.rb +62 -0
  75. data/spec/unit/cookbook_profiler/git_spec.rb +127 -0
  76. data/spec/unit/cookbook_profiler/identifiers_spec.rb +79 -0
  77. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb +9 -0
  78. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb +9 -0
  79. data/spec/unit/fixtures/command/cli_test_command.rb +26 -0
  80. data/spec/unit/fixtures/command/explicit_path_example.rb +7 -0
  81. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -0
  82. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile +3 -0
  83. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -0
  84. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/chefignore +96 -0
  85. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -0
  86. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -0
  87. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/.kitchen.yml +16 -0
  88. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/Berksfile +3 -0
  89. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/README.md +4 -0
  90. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/chefignore +96 -0
  91. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/metadata.rb +8 -0
  92. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/recipes/default.rb +8 -0
  93. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/.kitchen.yml +16 -0
  94. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/Berksfile +3 -0
  95. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/README.md +4 -0
  96. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/chefignore +96 -0
  97. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/metadata.rb +8 -0
  98. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/recipes/default.rb +8 -0
  99. data/spec/unit/fixtures/cookbooks_api/pruned_small_universe.json +1322 -0
  100. data/spec/unit/fixtures/cookbooks_api/small_universe.json +2987 -0
  101. data/spec/unit/fixtures/cookbooks_api/universe.json +1 -0
  102. data/spec/unit/fixtures/cookbooks_api/update_fixtures.rb +36 -0
  103. data/spec/unit/fixtures/dev_cookbooks/README.md +16 -0
  104. data/spec/unit/fixtures/dev_cookbooks/bar-cookbook.gitbundle +0 -0
  105. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/bin/.keep +0 -0
  106. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/embedded/.keep +0 -0
  107. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/embedded/bin/.keep +0 -0
  108. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/bin/.keep +0 -0
  109. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/apps/berkshelf/.keep +0 -0
  110. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/apps/test-kitchen/.keep +0 -0
  111. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/bin/.keep +0 -0
  112. data/spec/unit/fixtures/eg_omnibus_dir/valid/bin/.keep +0 -0
  113. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/integration_test +2 -0
  114. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/verify_me +5 -0
  115. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef-dk/.keep +0 -0
  116. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef/verify_me +3 -0
  117. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/test-kitchen/verify_me +2 -0
  118. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/bin/.keep +0 -0
  119. data/spec/unit/fixtures/example_app/Policyfile.rb +0 -0
  120. data/spec/unit/fixtures/example_cookbook/.gitignore +17 -0
  121. data/spec/unit/fixtures/example_cookbook/.kitchen.yml +16 -0
  122. data/spec/unit/fixtures/example_cookbook/Berksfile +3 -0
  123. data/spec/unit/fixtures/example_cookbook/README.md +4 -0
  124. data/spec/unit/fixtures/example_cookbook/chefignore +96 -0
  125. data/spec/unit/fixtures/example_cookbook/metadata.rb +8 -0
  126. data/spec/unit/fixtures/example_cookbook/recipes/default.rb +8 -0
  127. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/.kitchen.yml +16 -0
  128. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/Berksfile +3 -0
  129. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/README.md +4 -0
  130. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/chefignore +96 -0
  131. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/metadata.rb +8 -0
  132. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/recipes/default.rb +8 -0
  133. data/spec/unit/fixtures/local_path_cookbooks/metadata-missing/README.md +2 -0
  134. data/spec/unit/policyfile/chef_server_cookbook_source_spec.rb +34 -0
  135. data/spec/unit/policyfile/community_cookbook_source_spec.rb +51 -0
  136. data/spec/unit/policyfile/cookbook_spec_spec.rb +200 -0
  137. data/spec/unit/policyfile/null_cookbook_source_spec.rb +35 -0
  138. data/spec/unit/policyfile_builder_spec.rb +489 -0
  139. data/spec/unit/policyfile_demands_spec.rb +484 -0
  140. data/spec/unit/policyfile_evaluation_spec.rb +284 -0
  141. data/spec/unit/shell_out_spec.rb +34 -0
  142. metadata +422 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3b9f2f339c70e930b7bee3c3422c8b013e98e43b
4
+ data.tar.gz: d7cbff8ca1698edf60e5908d52ade0096c66416e
5
+ SHA512:
6
+ metadata.gz: c547ff5ccf4d910fa63487fb5d7137fee25944ee3e2482ce96bda6f645b5b93c1b20c03a846faa3a2aecfa3d70242b0431a0e06a762215518ce9880012498f0f
7
+ data.tar.gz: 701fc497bdb6322659ed4ca70ca45e0b6359c00a14296b12c0e4cb0bab0371db9f8c1f517eed6f7578a3389120ee0ecfa67f99a1f127b9919771837fe9fdafef
@@ -0,0 +1,192 @@
1
+ # Contributing to Chef
2
+
3
+ We are glad you want to contribute to Chef!
4
+
5
+ We utilize **Github Issues** for issue tracking and contributions. You can contribute in two ways:
6
+
7
+ 1. Reporting an issue or making a feature request [here](#issues).
8
+ 2. Adding features or fixing bugs yourself and contributing your code to Chef.
9
+
10
+ ## Contribution Process
11
+
12
+ We have a 3 step process that utilizes **Github Issues**:
13
+
14
+ 1. Sign our
15
+ [Individual Contributor License Agreement (CLA)](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L)
16
+ or [Corporate CLA](https://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856) online once.
17
+ 2. Create a Github Pull Request.
18
+ 3. Do [Code Review](#cr) with the **Chef Engineering Team** or **Chef Core Committers** on the pull request.
19
+
20
+ ### <a name="pulls"></a> Chef Pull Requests
21
+
22
+ Chef is built to last. We strive to ensure high quality throughout the Chef experience. In order to ensure
23
+ this, we require a couple of things for all pull requests to Chef:
24
+
25
+ 1. **Tests:** To ensure high quality code and protect against future regressions, we require all the
26
+ code in Chef to have at least unit test coverage. See the [spec/unit](https://github.com/opscode/chef/tree/master/spec/unit)
27
+ directory for the existing tests and use ```bundle exec rake spec``` to run them.
28
+ 2. **Green Travis Run:** We use [Travis CI](https://travis-ci.org/) in order to run our tests
29
+ continuously on all the pull requests. We require the Travis runs to succeed on every pull
30
+ request before being merged.
31
+
32
+ In addition to this it would be nice to include the description of the problem you are solving
33
+ with your change. You can use [Chef Issue Template](#issuetemplate) in the description section
34
+ of the pull request.
35
+
36
+ ### <a name="cr"></a> Chef Code Review Process
37
+
38
+ The Chef Code Review process happens on Github pull requests. See
39
+ [this article](https://help.github.com/articles/using-pull-requests) if you're not
40
+ familiar with Github Pull Requests.
41
+
42
+ Once you a pull request, the **Chef Engineering Team** or **Chef Core Committers** will review your code
43
+ and respond to you with any feedback they might have. The process at this point is as follows:
44
+
45
+ 1. 2 thumbs-ups are required from the **Chef Engineering Team** or **Chef Core Committers** for all merges.
46
+ 2. When ready, your pull request will be tagged with label `Ready For Merge`.
47
+ 3. Your patch will be merged into `master` including necessary documentation updates
48
+ and you will be included in `CHANGELOG.md`. Our goal is to have patches merged in 2 weeks
49
+ after they are marked to be merged.
50
+
51
+ If you would like to learn about when your code will be available in a release of Chef, read more about
52
+ [Chef Release Process](#release).
53
+
54
+ ### Contributor License Agreement (CLA)
55
+ Licensing is very important to open source projects. It helps ensure the
56
+ software continues to be available under the terms that the author desired.
57
+
58
+ Chef uses [the Apache 2.0 license](https://github.com/opscode/chef/blob/master/LICENSE)
59
+ to strike a balance between open contribution and allowing you to use the
60
+ software however you would like to.
61
+
62
+ The license tells you what rights you have that are provided by the copyright holder.
63
+ It is important that the contributor fully understands what rights they are
64
+ licensing and agrees to them. Sometimes the copyright holder isn't the contributor,
65
+ most often when the contributor is doing work for a company.
66
+
67
+ To make a good faith effort to ensure these criteria are met, Chef requires an Individual CLA
68
+ or a Corporate CLA for contributions. This agreement helps ensure you are aware of the
69
+ terms of the license you are contributing your copyrighted works under, which helps to
70
+ prevent the inclusion of works in the projects that the contributor does not hold the rights
71
+ to share.
72
+
73
+ It only takes a few minutes to complete a CLA, and you retain the copyright to your contribution.
74
+
75
+ You can complete our
76
+ [Individual CLA](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L) online.
77
+ If you're contributing on behalf of your employer and they retain the copyright for your works,
78
+ have your employer fill out our
79
+ [Corporate CLA](https://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856) instead.
80
+
81
+ ### Chef Obvious Fix Policy
82
+
83
+ Small contributions such as fixing spelling errors, where the content is small enough
84
+ to not be considered intellectual property, can be submitted by a contributor as a patch,
85
+ without a CLA.
86
+
87
+ As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality
88
+ or creative thinking. As long as the change does not affect functionality, some likely
89
+ examples include the following:
90
+
91
+ * Spelling / grammar fixes
92
+ * Typo correction, white space and formatting changes
93
+ * Comment clean up
94
+ * Bug fixes that change default return values or error codes stored in constants
95
+ * Adding logging messages or debugging output
96
+ * Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.
97
+ * Moving source files from one directory or package to another
98
+
99
+ **Whenever you invoke the “obvious fix” rule, please say so in your commit message:**
100
+
101
+ ```
102
+ ------------------------------------------------------------------------
103
+ commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5
104
+ Author: danielsdeleo <dan@opscode.com>
105
+ Date: Wed Sep 18 11:44:40 2013 -0700
106
+
107
+ Fix typo in config file docs.
108
+
109
+ Obvious fix.
110
+
111
+ ------------------------------------------------------------------------
112
+ ```
113
+
114
+ ## <a name="issues"></a> Chef Issue Tracking
115
+
116
+ Chef Issue Tracking is handled using Github Issues.
117
+
118
+ If you are familiar with Chef and know the component that is causing you a problem or if you
119
+ have a feature request on a specific component you can file an issue in the corresponding
120
+ Github project. All of our Open Source Software can be found in our
121
+ [Github organization](https://github.com/opscode/).
122
+
123
+ Otherwise you can file your issue in the [Chef project](https://github.com/opscode/chef/issues)
124
+ and we will make sure it gets filed against the appropriate project.
125
+
126
+ In order to decrease the back and forth an issues and help us get to the bottom of them quickly
127
+ we use below issue template. You can copy paste this code into the issue you are opening and
128
+ edit it accordingly.
129
+
130
+ <a name="issuetemplate"></a>
131
+ ```
132
+ ### Version:
133
+ [Version of the project installed]
134
+
135
+ ### Environment: [Details about the environment such as the Operating System, cookbook details, etc...]
136
+
137
+ ### Scenario:
138
+ [What you are trying to achieve and you can't?]
139
+
140
+
141
+
142
+ ### Steps to Reproduce:
143
+ [If you are filing an issue what are the things we need to do in order to repro your problem?]
144
+
145
+
146
+ ### Expected Result:
147
+ [What are you expecting to happen as the consequence of above reproduction steps?]
148
+
149
+
150
+ ### Actual Result:
151
+ [What actually happens after the reproduction steps?]
152
+ ```
153
+
154
+ ## <a name="release"></a> Chef Release Cycles
155
+
156
+ Our primary shipping vehicle is operating system specific packages that includes
157
+ all the requirements of Chef. We call these [Omnibus packages](https://github.com/opscode/omnibus-ruby)
158
+
159
+ We also release our software as gems to [Rubygems](http://rubygems.org/) but we strongly
160
+ recommend using Chef packages since they are the only combination of native libraries &
161
+ gems required by Chef that we test throughly.
162
+
163
+ Our version numbering closely follows [Semantic Versioning](http://semver.org/) standard. Our
164
+ standard version numbers look like X.Y.Z which mean:
165
+
166
+ * X is a major release, which may not be fully compatible with prior major releases
167
+ * Y is a minor release, which adds both new features and bug fixes
168
+ * Z is a patch release, which adds just bug fixes
169
+
170
+ We frequently make `alpha` and `beta` releases with version numbers that look like
171
+ `X.Y.Z.alpha.0` or `X.Y.Z.beta.1`. These releases are still well tested but not as
172
+ throughly as **Minor** or **Patch** releases.
173
+
174
+ We do a `Minor` release approximately every 3 months and `Patch` releases on a when-needed
175
+ basis for regressions, significant bugs, and security issues.
176
+
177
+ Announcements of releases are available on [Chef Blog](http://www.getchef.com/blog) when they are
178
+ available.
179
+
180
+ ## Chef Community
181
+
182
+ Chef is made possible by a strong community of developers and system administrators. If you have
183
+ any questions or if you would like to get involved in the Chef community you can check out:
184
+
185
+ * [chef](http://lists.opscode.com/sympa/info/chef) and [chef-dev](http://lists.opscode.com/sympa/info/chef-dev) mailing lists
186
+ * [\#chef](https://botbot.me/freenode/chef) and [\#chef-hacking](https://botbot.me/freenode/chef-hacking) IRC channels on irc.freenode.net
187
+
188
+ Also here are some additional pointers to some awesome Chef content:
189
+
190
+ * [Chef Docs](http://docs.opscode.com/)
191
+ * [Learn Chef](https://learnchef.opscode.com/)
192
+ * [Chef Inc](http://www.getchef.com/)
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.
@@ -0,0 +1,198 @@
1
+ # Chef Development Kit
2
+
3
+ Chef Development Kit (Chef DK) brings Chef and the development tools developed by the Chef Community together and acts as the consistent interface to this awesomeness. This awesomeness is composed of:
4
+
5
+ * [Chef][]
6
+ * [Berkshelf][]
7
+ * [Test Kitchen][]
8
+ * [ChefSpec][]
9
+ * [Foodcritic][]
10
+
11
+ This repository contains the code for the `chef` command. The full
12
+ package is built via the 'chefdk' project in
13
+ [omnibus-chef](https://github.com/opscode/omnibus-chef).
14
+
15
+ ## Installation
16
+
17
+ You can get the [latest release of ChefDK from the downloads page][ChefDK].
18
+
19
+ On Mac OS X, you can also use [homebrew-cask](http://caskroom.io)
20
+ to install ChefDK.
21
+
22
+ Once you install the package, the `chef-client` suite, `berks`,
23
+ `kitchen`, and this application (`chef`) will be symlinked into your
24
+ system bin directory, ready to use.
25
+
26
+ ## Usage
27
+
28
+ For help with [Berkshelf][], [Test Kitchen][], [ChefSpec][] or [Foodcritic][],
29
+ visit those projects' homepages for documentation and guides. For help with
30
+ `chef-client` and `knife`, visit the [Chef documentation][]
31
+ and [Learn Chef][].
32
+
33
+ ### The `chef` Command
34
+
35
+ Our goal is for `chef` to become a workflow tool that builds on the
36
+ ideas of Berkshelf to provide an awesome experience that encourages
37
+ quick iteration and testing (and makes those things easy) and provides a
38
+ way to easily, reliably, and repeatably roll out new automation code to
39
+ your infrastructure.
40
+
41
+ While we've got a long way to go before we reach that goal we do have
42
+ some helpful bits of functionality already included in the `chef`
43
+ command:
44
+
45
+ #### `chef generate`
46
+ The generate subcommand generates skeleton Chef code
47
+ layouts so you can skip repetitive boilerplate and get down to
48
+ automating your infrastructure quickly. Unlike other generators, it only
49
+ generates the minimum required files when creating a cookbook so you can
50
+ focus on the task at hand without getting overwhelmed by stuff you don't
51
+ need.
52
+
53
+ The following generators are built-in:
54
+
55
+ * `chef generate app` Creates an "application" layout that supports
56
+ multiple cookbooks. This is a somewhat experimental compromise between
57
+ the one-repo-per-cookbook and monolithic-chef-repo styles of cookbook
58
+ management.
59
+
60
+ * `chef generate cookbook` Creates a single cookbook.
61
+ * `chef generate recipe` Creates a new recipe file in an existing
62
+ cookbook.
63
+ * `chef generate attribute` Creates a new attributes file in an existing
64
+ cookbook.
65
+ * `chef generate template` Creates a new template file in an existing
66
+ cookbook. Use the `-s SOURCE` option to copy a source file's content to
67
+ populate the template.
68
+ * `chef generate file` Creates a new cookbook file in an existing
69
+ cookbook. Supports the `-s SOURCE` option similar to template.
70
+ * `chef generate lwrp` Creates a new LWRP resource and provider in an
71
+ existing cookbook.
72
+
73
+ #### `chef gem`
74
+ `chef gem` is a wrapper command that manages installation and updating
75
+ of rubygems for the Ruby installation embedded in the ChefDK package.
76
+ This allows you to install knife plugins, Test Kitchen drivers, and
77
+ other Ruby applications that are not packaged with ChefDK.
78
+
79
+ Gems are installed to a `.chefdk` directory in your home directory; any
80
+ executables included with a gem you install will be created in
81
+ `~/.chefdk/gem/ruby/2.1.0/bin`. You can run these executables with
82
+ `chef exec`, or use `chef shell-init` to add ChefDK's paths to your
83
+ environment. Those commands are documented below.
84
+
85
+ #### `chef verify`
86
+ `chef verify` tests the embedded applications. By default it runs a
87
+ quick "smoke test" to verify that the embedded applications are
88
+ installed correctly and can run basic commands. As an end user this is
89
+ probably all you'll ever need, but `verify` can also optionally run unit
90
+ and integration tests by supplying the `--unit` and `--integration`
91
+ flags, respectively.
92
+
93
+ *WARNING:* The integration tests will do dangerous things like start
94
+ HTTP servers with access to your filesystem and even create users and
95
+ groups if run with sufficient privileges. The tests may also be
96
+ sensitive to your machine's configuration. If you choose to run these,
97
+ we recommend to only run them on dedicated, isolated hosts (we do this
98
+ in our build cluster to verify each build).
99
+
100
+ ### `chef exec`
101
+ `chef exec <command>` runs any arbitrary shell command with the PATH
102
+ environment variable and the ruby environment variables (GEM_HOME,
103
+ GEM_PATH, etc) setup to point at the embedded ChefDK omnibus environment.
104
+
105
+ ### `chef shell-init`
106
+ `chef shell-init SHELL_NAME` emits shell commands that modify your
107
+ environment to make ChefDK your primary ruby. For more information to
108
+ help you decide if this is desirable and instructions, see "Using ChefDK
109
+ as Your Primary Development Environment" below.
110
+
111
+ ### Using ChefDK as Your Primary Development Environment
112
+
113
+ By default, ChefDK only adds a few select applications to your `PATH`
114
+ and packages them in such a way that they are isolated from any other
115
+ Ruby development tools you have on your system. If you're happily using
116
+ your system ruby, rvm, rbenv, chruby or any other development
117
+ environment, you can continue to do so. Just ensure that the ChefDK
118
+ provided applications appear first in your `PATH` before any
119
+ gem-installed versions and you're good to go.
120
+
121
+ If you'd like to use ChefDK as your primary Ruby/Chef development
122
+ environment, however, you can do so by initializing your shell with
123
+ ChefDK's environment.
124
+
125
+ To try it temporarily, in a new terminal session, run:
126
+
127
+ eval "$(chef shell-init SHELL_NAME)"
128
+
129
+ where `SHELL_NAME` is the name of your shell, (usually bash, but zsh is
130
+ also common). This modifies your `PATH` and `GEM_*` environment
131
+ variables to include ChefDK's paths (run without the `eval` to see the
132
+ generated code). Now your default `ruby` and associated tools will be
133
+ the ones from ChefDK:
134
+
135
+ which ruby
136
+ # => /opt/chefdk/embedded/bin/ruby
137
+
138
+ To add ChefDK to your shell's environment permanently, add the
139
+ initialization step to your shell's profile:
140
+
141
+ echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_PROFILE
142
+
143
+ Where `YOUR_SHELL_PROFILE` is `~/.bash_profile` for most bash users,
144
+ `~/.zshrc` for zsh, and `~/.bashrc` on Ubuntu.
145
+
146
+ ## Uninstallation Instructions
147
+
148
+ ### Mac OS X
149
+
150
+ You can uninstall Chef Development Kit on Mac using below commands:
151
+
152
+ ```
153
+ # Remove the installed files
154
+ sudo rm -rf /opt/chefdk
155
+
156
+ # Remove the system installation entry
157
+ sudo pkgutil --forget com.getchef.pkg.chefdk
158
+
159
+ # Remove the symlinks under /usr/bin for Chef Development Kit
160
+ ls -la /usr/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/bin/%
161
+
162
+ ```
163
+
164
+ ### Windows
165
+
166
+ You can use `Add / Remove Programs` on Windows to remove the Chef Development
167
+ Kit from your system.
168
+
169
+ ### RHEL
170
+
171
+ You can use `rpm` to uninstall Chef Development Kit on RHEL based systems:
172
+
173
+ ```
174
+ rpm -qa *chefdk*
175
+ yum remove <package>
176
+ ```
177
+
178
+ ### Ubuntu
179
+
180
+ You can use `dpkg` to uninstall Chef Development Kit on Ubuntu based systems:
181
+
182
+ ```
183
+ dpkg --list | grep chefdk # or dpkg --status chefdk
184
+
185
+ # Purge chefdk from the system.
186
+ # see man dkpg for details
187
+ dpkg -P chefdk
188
+ ```
189
+ - - -
190
+
191
+ [Berkshelf]: http://berkshelf.com "Berkshelf"
192
+ [Chef]: https://www.getchef.com "Chef"
193
+ [ChefDK]: https://www.getchef.com/downloads/chef-dk "Chef Development Kit"
194
+ [Chef Documentation]: http://docs.opscode.com "Chef Documentation"
195
+ [ChefSpec]: http://chefspec.org "ChefSpec"
196
+ [Foodcritic]: http://foodcritic.io "Foodcritic"
197
+ [Learn Chef]: http://learn.getchef.com "Learn Chef"
198
+ [Test Kitchen]: http://kitchen.ci "Test Kitchen"