terraspace-bundler 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +17 -0
  3. data/.rspec +3 -0
  4. data/CHANGELOG.md +7 -0
  5. data/Gemfile +4 -0
  6. data/Guardfile +19 -0
  7. data/LICENSE.txt +201 -0
  8. data/README.md +82 -0
  9. data/Rakefile +6 -0
  10. data/exe/terraform-bundler +14 -0
  11. data/lib/terraspace-bundler.rb +1 -0
  12. data/lib/terraspace_bundler.rb +23 -0
  13. data/lib/terraspace_bundler/autoloader.rb +22 -0
  14. data/lib/terraspace_bundler/cli.rb +24 -0
  15. data/lib/terraspace_bundler/cli/base.rb +9 -0
  16. data/lib/terraspace_bundler/cli/bundle.rb +27 -0
  17. data/lib/terraspace_bundler/cli/clean.rb +11 -0
  18. data/lib/terraspace_bundler/cli/help.rb +9 -0
  19. data/lib/terraspace_bundler/cli/help/bundle/install.md +3 -0
  20. data/lib/terraspace_bundler/cli/help/completion.md +20 -0
  21. data/lib/terraspace_bundler/cli/help/completion_script.md +3 -0
  22. data/lib/terraspace_bundler/cli/install.rb +7 -0
  23. data/lib/terraspace_bundler/cli/update.rb +7 -0
  24. data/lib/terraspace_bundler/command.rb +89 -0
  25. data/lib/terraspace_bundler/completer.rb +159 -0
  26. data/lib/terraspace_bundler/completer/script.rb +6 -0
  27. data/lib/terraspace_bundler/completer/script.sh +10 -0
  28. data/lib/terraspace_bundler/config.rb +15 -0
  29. data/lib/terraspace_bundler/core.rb +21 -0
  30. data/lib/terraspace_bundler/dsl.rb +18 -0
  31. data/lib/terraspace_bundler/dsl/syntax.rb +20 -0
  32. data/lib/terraspace_bundler/helper/git.rb +21 -0
  33. data/lib/terraspace_bundler/installer.rb +45 -0
  34. data/lib/terraspace_bundler/logger.rb +26 -0
  35. data/lib/terraspace_bundler/logging.rb +7 -0
  36. data/lib/terraspace_bundler/mod.rb +85 -0
  37. data/lib/terraspace_bundler/mod/export.rb +23 -0
  38. data/lib/terraspace_bundler/mod/locked.rb +48 -0
  39. data/lib/terraspace_bundler/mod/registry.rb +72 -0
  40. data/lib/terraspace_bundler/mod/sync.rb +53 -0
  41. data/lib/terraspace_bundler/mod/tmp_paths.rb +28 -0
  42. data/lib/terraspace_bundler/setup.rb +20 -0
  43. data/lib/terraspace_bundler/syncer.rb +13 -0
  44. data/lib/terraspace_bundler/updater.rb +49 -0
  45. data/lib/terraspace_bundler/updater/lockfile.rb +48 -0
  46. data/lib/terraspace_bundler/util/registry.rb +24 -0
  47. data/lib/terraspace_bundler/version.rb +3 -0
  48. data/spec/fixtures/Terrafile +6 -0
  49. data/spec/spec_helper.rb +29 -0
  50. data/spec/terraform_bundler/installer_spec.rb +16 -0
  51. data/terraspace-bundler.gemspec +32 -0
  52. metadata +237 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 631c34ce3db2daed84f18ba29202a80f774f4b109667f7b45782e8650e78a546
4
+ data.tar.gz: 86eecdcc7707f0b69dc1119f8998d26db27f379c6e7e8ca40fb57bdcd06f7fc2
5
+ SHA512:
6
+ metadata.gz: 66db99a20990496644bac73075aa9e5cb8d5e998cfdfce7b15efc65ea497d8d01bfd21502e91ea914965b7400f8e278d4ce41994a5e7c0fcbba401841f9be083
7
+ data.tar.gz: 8f6d8295f23d9521440584ee6ed84b1d7568900211a89b4bcfd67e5b5a5238c2b629f9d161dd540770c705b8eebc05f9a7ecbe70618399e4c070abcaff6a7e04
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ /.bundle
4
+ /.config
5
+ /.yardoc
6
+ /_yardoc
7
+ /coverage
8
+ /doc/
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
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --require spec_helper
2
+ --color
3
+ --format documentation
@@ -0,0 +1,7 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
5
+
6
+ ## [0.1.0]
7
+ - Initial release.
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem dependencies in terraspace-bundler.gemspec
4
+ gemspec
@@ -0,0 +1,19 @@
1
+ guard "bundler", cmd: "bundle" do
2
+ watch("Gemfile")
3
+ watch(/^.+\.gemspec/)
4
+ end
5
+
6
+ guard :rspec, cmd: "bundle exec rspec" do
7
+ require "guard/rspec/dsl"
8
+ dsl = Guard::RSpec::Dsl.new(self)
9
+
10
+ # RSpec files
11
+ rspec = dsl.rspec
12
+ watch(rspec.spec_helper) { rspec.spec_dir }
13
+ watch(rspec.spec_support) { rspec.spec_dir }
14
+ watch(rspec.spec_files)
15
+
16
+ # Ruby files
17
+ ruby = dsl.ruby
18
+ dsl.watch_spec_files_for(ruby.lib_files)
19
+ end
@@ -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,82 @@
1
+ # terraspace-bundler
2
+
3
+ Bundles terraform modules based on a `Terrafile` to the `vendor/modules` folder.
4
+
5
+ ## Installation
6
+
7
+ To install:
8
+
9
+ gem install terraspace-bundler
10
+
11
+ ## Usage
12
+
13
+ Create a `Terrafile` file:
14
+
15
+ ```ruby
16
+ org "boltopspro" # set default org
17
+
18
+ # GitHub repo with default org
19
+ mod "elb", source: "terraform-aws-elb", version: "master"
20
+ mod "ec2", source: "terraform-aws-ec2", version: "branch-name"
21
+
22
+ # GitHub repo with explicit org
23
+ mod "rds", source: "boltopspro/terraform-aws-rds", version: "v0.1.0"
24
+
25
+ # Terraform registry
26
+ mod "sg", source: "terraform-aws-modules/security-group/aws", version: "3.10.0"
27
+ ```
28
+
29
+ Running `terraspace bundle` creates the `Terrafile.lock` file, which locks the downloaded versions.
30
+
31
+ terraspace bundle
32
+
33
+ ## Updating
34
+
35
+ To update all the locked versions in `Terrafile.lock` run `terraspace bundle update`. You can also simply delete the `Terrafile.lock` file.
36
+
37
+ terraspace bundle update
38
+
39
+ You can selectively update only one module:
40
+
41
+ terraspace bundle update MOD
42
+
43
+ ## Removing vendor/modules
44
+
45
+ The `terraspace bundle` commands will only update the modules it knows about in `Terrafile`. To clear out old modules, delete them from `vendor/modules`. You can clean them all out like so:
46
+
47
+ rm -rf vendor/modules
48
+ terraspace bundle update
49
+
50
+ ## base url
51
+
52
+ The base url used for clone is `git@github.com:`. You can change it with `base_url`, example:
53
+
54
+ ```ruby
55
+ org "boltops-tools" # set default org
56
+ base_url "https://github.com/" # default base url for git clone
57
+
58
+ mod "s3", source: "terraform-aws-s3", version: "master"
59
+ ```
60
+
61
+ ## export_path
62
+
63
+ The default export path is `vendor/modules`, you can change it:
64
+
65
+ ```ruby
66
+ org "boltops-tools" # set default org
67
+ export_path "app/modules"
68
+
69
+ mod "s3", source: "terraform-aws-s3", version: "master"
70
+ ```
71
+
72
+ ## Notes
73
+
74
+ * Simple implementation for [Terraspace](https://terraspace.cloud/) use.
75
+ * Handles updating the `Terrafile.lock` based on the `Terrafile`
76
+ * Others running the `terraspace bundle install` will install the exact same module versions based the `Terrafile.lock`.
77
+ * To update `Terraform.lock` run `terraspace bundle update`.
78
+ * The repos are downloaded to `/tmp/terraspace-bundler` area as a cache. Delete the cache by running `terraspace bundle clean`.
79
+
80
+ ## Contributing
81
+
82
+ Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace-bundler.
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ task default: :spec
5
+
6
+ RSpec::Core::RakeTask.new
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # Trap ^C
4
+ Signal.trap("INT") {
5
+ puts "\nCtrl-C detected. Exiting..."
6
+ sleep 0.1
7
+ exit
8
+ }
9
+
10
+ $:.unshift(File.expand_path("../../lib", __FILE__))
11
+ require "terraspace-bundler"
12
+ require "terraspace_bundler/cli"
13
+
14
+ TerraspaceBundler::CLI.start(ARGV)
@@ -0,0 +1 @@
1
+ require_relative "terraspace_bundler"
@@ -0,0 +1,23 @@
1
+ $:.unshift(File.expand_path("../", __FILE__))
2
+ require "active_support/core_ext/class"
3
+ require "active_support/core_ext/hash"
4
+ require "active_support/core_ext/string"
5
+ require "active_support/ordered_options"
6
+ require "dsl_evaluator"
7
+ require "fileutils"
8
+ require "memoist"
9
+ require "rainbow/ext/string"
10
+ require "terraspace_bundler/version"
11
+ require "yaml"
12
+
13
+ require "terraspace_bundler/autoloader"
14
+ TerraspaceBundler::Autoloader.setup
15
+
16
+ DslEvaluator.backtrace_reject = "lib/terraspace_bundler"
17
+
18
+ module TerraspaceBundler
19
+ class Error < StandardError; end
20
+ extend Core
21
+ end
22
+
23
+ TB = TerraspaceBundler
@@ -0,0 +1,22 @@
1
+ require "zeitwerk"
2
+
3
+ module TerraspaceBundler
4
+ class Autoloader
5
+ class Inflector < Zeitwerk::Inflector
6
+ def camelize(basename, _abspath)
7
+ map = { cli: "CLI", version: "VERSION" }
8
+ map[basename.to_sym] || super
9
+ end
10
+ end
11
+
12
+ class << self
13
+ def setup
14
+ loader = Zeitwerk::Loader.new
15
+ loader.inflector = Inflector.new
16
+ loader.push_dir(File.dirname(__dir__)) # lib
17
+ loader.ignore("#{File.dirname(__dir__)}/terraspace-bundler.rb")
18
+ loader.setup
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,24 @@
1
+ module TerraspaceBundler
2
+ class CLI < Command
3
+ desc "bundle SUBCOMMAND", "bundle subcommands"
4
+ long_desc Help.text(:bundle)
5
+ subcommand "bundle", Bundle
6
+
7
+ desc "completion *PARAMS", "Prints words for auto-completion."
8
+ long_desc Help.text(:completion)
9
+ def completion(*params)
10
+ Completer.new(CLI, *params).run
11
+ end
12
+
13
+ desc "completion_script", "Generates a script that can be eval to setup auto-completion."
14
+ long_desc Help.text(:completion_script)
15
+ def completion_script
16
+ Completer::Script.generate
17
+ end
18
+
19
+ desc "version", "prints version"
20
+ def version
21
+ puts VERSION
22
+ end
23
+ end
24
+ end