omnibus 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (62) hide show
  1. checksums.yaml +15 -0
  2. data/.gitignore +9 -0
  3. data/.rspec +1 -0
  4. data/.yardopts +7 -0
  5. data/CHANGELOG.md +3 -0
  6. data/Gemfile +9 -0
  7. data/LICENSE +201 -0
  8. data/NOTICE +9 -0
  9. data/README.md +186 -0
  10. data/Rakefile +7 -0
  11. data/bin/makeself-header.sh +401 -0
  12. data/bin/makeself.sh +407 -0
  13. data/bin/omnibus +11 -0
  14. data/lib/omnibus.rb +280 -0
  15. data/lib/omnibus/build_version.rb +281 -0
  16. data/lib/omnibus/builder.rb +323 -0
  17. data/lib/omnibus/clean_tasks.rb +30 -0
  18. data/lib/omnibus/cli.rb +35 -0
  19. data/lib/omnibus/cli/application.rb +136 -0
  20. data/lib/omnibus/cli/base.rb +112 -0
  21. data/lib/omnibus/cli/build.rb +66 -0
  22. data/lib/omnibus/cli/cache.rb +60 -0
  23. data/lib/omnibus/config.rb +186 -0
  24. data/lib/omnibus/exceptions.rb +54 -0
  25. data/lib/omnibus/fetcher.rb +184 -0
  26. data/lib/omnibus/fetchers.rb +22 -0
  27. data/lib/omnibus/fetchers/git_fetcher.rb +212 -0
  28. data/lib/omnibus/fetchers/net_fetcher.rb +191 -0
  29. data/lib/omnibus/fetchers/path_fetcher.rb +65 -0
  30. data/lib/omnibus/fetchers/s3_cache_fetcher.rb +42 -0
  31. data/lib/omnibus/health_check.rb +260 -0
  32. data/lib/omnibus/library.rb +70 -0
  33. data/lib/omnibus/overrides.rb +69 -0
  34. data/lib/omnibus/project.rb +566 -0
  35. data/lib/omnibus/reports.rb +99 -0
  36. data/lib/omnibus/s3_cacher.rb +136 -0
  37. data/lib/omnibus/software.rb +430 -0
  38. data/lib/omnibus/templates/Berksfile.erb +3 -0
  39. data/lib/omnibus/templates/Gemfile.erb +4 -0
  40. data/lib/omnibus/templates/README.md.erb +102 -0
  41. data/lib/omnibus/templates/Vagrantfile.erb +95 -0
  42. data/lib/omnibus/templates/gitignore.erb +8 -0
  43. data/lib/omnibus/templates/omnibus.rb.example.erb +5 -0
  44. data/lib/omnibus/templates/package_scripts/makeselfinst.erb +27 -0
  45. data/lib/omnibus/templates/package_scripts/postinst.erb +17 -0
  46. data/lib/omnibus/templates/package_scripts/postrm.erb +9 -0
  47. data/lib/omnibus/templates/project.rb.erb +21 -0
  48. data/lib/omnibus/templates/software/c-example.rb.erb +42 -0
  49. data/lib/omnibus/templates/software/erlang-example.rb.erb +38 -0
  50. data/lib/omnibus/templates/software/ruby-example.rb.erb +24 -0
  51. data/lib/omnibus/util.rb +61 -0
  52. data/lib/omnibus/version.rb +20 -0
  53. data/omnibus.gemspec +34 -0
  54. data/spec/build_version_spec.rb +228 -0
  55. data/spec/data/overrides/bad_line.overrides +3 -0
  56. data/spec/data/overrides/good.overrides +5 -0
  57. data/spec/data/overrides/with_dupes.overrides +4 -0
  58. data/spec/data/software/erchef.rb +40 -0
  59. data/spec/overrides_spec.rb +114 -0
  60. data/spec/software_spec.rb +71 -0
  61. data/spec/spec_helper.rb +28 -0
  62. metadata +239 -0
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ YzI1YzkzMTliYzc1NmUwM2E0NDRmMzhkNmFjZmIxNDUwODBjNTZjYw==
5
+ data.tar.gz: !binary |-
6
+ NzQzY2IyNDUwYTNkYTFlZmZlYTk5ODAxMmE2NDQ4NzhiZTAyZDI1NA==
7
+ !binary "U0hBNTEy":
8
+ metadata.gz: !binary |-
9
+ ZTczMTQ5ZjNkNzQ2YTc2ZDM5OWQ0NTEzOWQ3ZWNlZDBjMDY5ODA3NDQ2ZTlj
10
+ ZTA2MzEwZGQzMDI1M2EyZDc1YzFkMmJiNWZhNTYzNzM3NTM4ODMyNzU5MTgy
11
+ ZjA3MzZkNTJjNzVjNjc2MGM1M2ViZTM5YjEwZWZiMDM1NWY4Y2I=
12
+ data.tar.gz: !binary |-
13
+ ZjM1MzdjNjA5MmJiOGIwYzY1NDhlYWQxOTM4ZmQ5NWIxNzNkNzczYzM4OTQ2
14
+ OWZmOTY1NzZiY2VkYjg5MTJlZGIxODFkYjk4NDY0MDUyODQxYmE4OTg2NTRi
15
+ OWYxZWVkNTAzZGQ3ODBiZDlkMzZkMjEyNTgxY2E0OWQxOGU2NmY=
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ *.gem
2
+ tmp
3
+
4
+ # Bundler related
5
+ Gemfile.lock
6
+ .bundle/
7
+ vendor/
8
+ .yardoc
9
+ doc/
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color --format doc
data/.yardopts ADDED
@@ -0,0 +1,7 @@
1
+ --markup=markdown
2
+ --markup-provider=redcarpet
3
+ --readme=README.md
4
+ -
5
+ CHANGELOG.md
6
+ LICENSE
7
+ TODO.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ ## 1.0.0
2
+
3
+ * The initial release.
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
4
+
5
+ group :docs do
6
+ gem "yard", "~> 0.8.5"
7
+ gem "redcarpet", "~> 2.2.2"
8
+ gem "github-markup", "~> 0.7.5"
9
+ end
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/NOTICE ADDED
@@ -0,0 +1,9 @@
1
+ omnibus-ruby NOTICE
2
+ ===================
3
+
4
+ Developed at Opscode (http://www.opscode.com).
5
+
6
+ Contributors and Copyright holders:
7
+
8
+ * Copyright 2012, Opscode, Inc. <legal@opscode.com>
9
+
data/README.md ADDED
@@ -0,0 +1,186 @@
1
+ ## Omnibus
2
+
3
+ Easily create full-stack installers for your project across a variety
4
+ of platforms.
5
+
6
+ ## Prerequisites
7
+
8
+ Omnibus is designed to run with a minimal set of prerequisites. You'll
9
+ need the following:
10
+
11
+ - Ruby 1.9 or later (http://ruby-lang.org)
12
+ - Bundler (http://gembundler.com, http://rubygems.org/gems/bundler)
13
+
14
+ Though not *strictly* necessary, Vagrant makes using Omnibus easier,
15
+ and is highly recommended.
16
+ - Vagrant 1.2.1 or later (http://www.vagrantup.com)
17
+
18
+ ## Get Started
19
+
20
+ Omnibus provides both a DSL for defining Omnibus projects for your
21
+ software, as well as a command-line tool for generating installer
22
+ artifacts from that definition.
23
+
24
+ To get started, install Omnibus locally on your workstation.
25
+
26
+ ```
27
+ $ gem install omnibus
28
+ ```
29
+
30
+ You can now create an Omnibus project in your current directory by
31
+ using the project generator feature.
32
+
33
+ ```
34
+ $ omnibus project $MY_PROJECT_NAME
35
+ ```
36
+
37
+ This will generate a complete project skeleton in the directory
38
+ `omnibus-$MY_PROJECT_NAME`
39
+
40
+ This minimal project will actually build.
41
+
42
+ ``` shell
43
+ $ cd omnibus-$MY_PROJECT_NAME
44
+ $ bundle install --binstubs
45
+ $ bin/omnibus build project $MY_PROJECT_NAME
46
+ ```
47
+
48
+ More details can be found in the generated project README file.
49
+
50
+ ## Configuration DSL
51
+
52
+ Though the template project will build, it won't do anything exciting.
53
+ For that, you'll need to use the Omnibus DSL to define the specifics
54
+ of your own application.
55
+
56
+ ### Software
57
+
58
+ Omnibus "software" files define individual software components that go
59
+ into making your overall package. They are the building blocks of
60
+ your application. The Software DSL provides a way to define where to
61
+ retrieve the software sources, how to build them, and what
62
+ dependencies they have. These dependencies are also defined in their
63
+ own Software DSL files, thus forming the basis for a dependency-aware
64
+ build ordering.
65
+
66
+ All Software definitions should go in the `config/software` directory
67
+ of your Omnibus project repository.
68
+
69
+ Opscode has created software definitions for a number of
70
+ commonly-needed components, available in the
71
+ [omnibus-software](https://github.com/opscode/omnibus-software.git)
72
+ repository. When you create a new project skeleton using Omnibus,
73
+ this is automatically added to the project's Gemfile, making all these
74
+ software definitions available to you. (If you prefer, however, you
75
+ can write your own versions of these same definitions in your project
76
+ repository; local copies in `config/software` have precedence over
77
+ anything from the `omnibus-software` repository.)
78
+
79
+ An example:
80
+
81
+ ```ruby
82
+ name "ruby"
83
+ version "1.9.2-p290"
84
+ source :url => "http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-#{version}.tar.gz",
85
+ :md5 => "604da71839a6ae02b5b5b5e1b792d5eb"
86
+
87
+ dependency "zlib"
88
+ dependency "ncurses"
89
+ dependency "openssl"
90
+
91
+ relative_path "ruby-#{version}"
92
+
93
+ build do
94
+ command "./configure"
95
+ command "make"
96
+ command "make install"
97
+ end
98
+ ```
99
+
100
+ Some of the DSL methods available include:
101
+
102
+ **name**: The name of the software component.
103
+
104
+ **version**: The version of the software component.
105
+
106
+ **source**: Directions to the location of the source.
107
+
108
+ **dependency**: An Omnibus software-defined component that this software depends on.
109
+
110
+ **relative_path**: The relative path of the extracted tarball.
111
+
112
+ **build**: The build instructions.
113
+
114
+ **command**: An individual build step.
115
+
116
+ For more, consult the documentation.
117
+
118
+ ### Projects
119
+
120
+ A Project DSL file defines your actual application; this is the thing
121
+ you are creating a full-stack installer for in the first place. It
122
+ provides a means to define the dependencies of the project (again, as
123
+ specified in Software DSL definition files), as well as ways to set
124
+ installer package metadata.
125
+
126
+ All Project definitions (yes, you can have more than one) should go in
127
+ the `config/projects` directory of your Omnibus project repository.
128
+
129
+ ```ruby
130
+ name "chef-full"
131
+ maintainer "YOUR NAME"
132
+ homepage "http://yoursite.com"
133
+
134
+ install_path "/opt/chef"
135
+ build_version "0.10.8"
136
+ build_iteration 4
137
+
138
+ dependency "chef"
139
+ ```
140
+
141
+ Some DSL methods available include:
142
+
143
+ **name:** The name of the project.
144
+
145
+ **install_path:** The desired install location of the package.
146
+
147
+ **build_version:** The package version.
148
+
149
+ **build_iteration:** The package iteration number.
150
+
151
+ **dependency**: An Omnibus software-defined component to include in this package.
152
+
153
+ For more, see the documentation.
154
+
155
+ ## A Note On Builds
156
+
157
+ As stated above, the generated project skeleton can run "as-is".
158
+ However, Omnibus determines the platform for which to build an
159
+ installer based on *the platform it is currently running on*. That
160
+ is, you can only generate a `.deb` file for Ubuntu if you're actually
161
+ running Omnibus *on Ubuntu*.
162
+
163
+ This is currently achieved using [Vagrant](http://www.vagrantup.com).
164
+ A valid `Vagrantfile` for generating builds on Ubuntu and Centos
165
+ platforms (though Omnibus is not limited to just those!) is created
166
+ for each project that you generate using `omnibus project
167
+ $MY_PROJECT_NAME`
168
+
169
+ ## License
170
+
171
+ See the LICENSE and NOTICE files for more information.
172
+
173
+ Copyright: Copyright (c) 2012--2013 Opscode, Inc.
174
+ License: Apache License, Version 2.0
175
+
176
+ Licensed under the Apache License, Version 2.0 (the "License");
177
+ you may not use this file except in compliance with the License.
178
+ You may obtain a copy of the License at
179
+
180
+ http://www.apache.org/licenses/LICENSE-2.0
181
+
182
+ Unless required by applicable law or agreed to in writing, software
183
+ distributed under the License is distributed on an "AS IS" BASIS,
184
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
185
+ See the License for the specific language governing permissions and
186
+ limitations under the License.