cartage 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1f67642374f3f5997dd5d735d20b33e8e035c5c
+  data.tar.gz: 64cd9abc15c2bf0a2e8097545a1013d434b38e6b
+SHA512:
+  metadata.gz: 5939952a64d810668aeec416727bdaadda5011d594115719bbfd5aaf3af3ee86d89614dd3689d7cfc30c41a76b459e7de1a40c811f13285c5eb56b8e101d1d42
+  data.tar.gz: dfd005d425fff150f5b465c1a88af03f6e2df935a3c2152f0607e84265524d44a6ef90d8dcb3c59b28e0463d2ded90ae9ece49a58dcf87803fe91e87b8e9b4d3

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  # .minitest.rb ensures that the gem version of minitest is used.
+  at.testlib = ".minitest.rb"
+end

data/.gemtest

@@ -0,0 +1 @@
+

data/.minitest.rb

@@ -0,0 +1,2 @@
+gem "minitest"
+require "minitest/autorun"

data/.travis.yml

@@ -0,0 +1,36 @@
+---
+sudo: false
+language: ruby
+rvm:
+  - "2.2"
+  - "2.1"
+  - 2.0.0
+  - ruby-head
+  - jruby-head
+  - jruby-9.0.0.0.pre1
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-head
+    - rvm: jruby-9.0.0.0.pre1
+    - rvm: ruby-head
+gemfile:
+  - Gemfile
+before_script:
+  - |
+    case "${TRAVIS_RUBY_VERSION}" in
+      rbx*)
+        gem install psych
+        ;;
+    esac
+  - rake travis:before -t
+script: rake travis
+after_script:
+  - rake travis:after -t
+notifications:
+  email:
+    recipients:
+      - aziegler@kineticcafe.com
+    on_success: change
+    on_failure: always

data/Cartage.yml.rdoc

@@ -0,0 +1,271 @@
+= An Example cartage.yml
+
+The best way to understand how to configure Cartage is to see an annotated
+example of a +cartage.yml+ file.
+
+== Secrets and cartage.yml
+
+The items in the main part of the Cartage configuration are *not* generally
+secret, but they are also not typically things that would be set in a static
+configuration file. The main value that would probably be set under most
+circumstances is the +name+ value.
+
+Because Cartage reads its configuration through ERB, the following structure is
+recommended for +config/cartage.yml+.
+
+    ---
+    name: my-application
+
+    # This must not be indented for it to work.
+    <% if File.exist?('config/ansible/cartage.yml') %>
+    <%= File.read('config/ansible/cartage.yml') %>
+    <% end %>
+    <% if File.exist?('config/local/cartage.yml') %>
+    <%= File.read('config/local/cartage.yml') %>
+    <% end %>
+
+== Main Cartage Configuration Options
+
+=== +name+
+
+The name of the application. Optional, defaults to the basename of the origin
+Git URL. Overridden with <tt>cartage --name NAME</tt>.
+
+    name: my-application
+
+=== +target+
+
+The target path for the Cartage package. Optional and defaults to
+<tt>./tmp</tt>. Overridden with <tt>cartage --target PATH</tt>.
+
+    target: tmp/cartage
+
+=== +root_path+
+
+The root path of the application. Optional, defaults to the top of the Git
+repository (<tt>git rev-parse --show-cdup</tt>). Overridden with <tt>cartage
+--root-path ROOT_PATH</tt>.
+
+    root_path: .
+
+=== +timestamp+
+
+The timestamp for the final package (which is
+<tt><em>name</em>-<em>timestamp</em></tt>). Optional, defaults to the current
+time in UTC. Overridden with <tt>cartage --timestamp TIMESTAMP</tt>. This
+value is *not* validated to be a time value when supplied.
+
+    timestamp: not-a-timestamp
+
+=== +bundle_cache+
+
+The bundle cache path, where the package’s <tt>vendor-bundle.tar.bz2</tt>
+will be stored between builds. Optional, defaults to <tt>./tmp</tt>.
+Overridden with <tt>cartage --bundle-cache BUNDLE_CACHE</tt>.
+
+    bundle_cache: tmp/cache
+
+=== +without+
+
+The groups to exclude from <tt>bundle install</tt>. Optional, defaults to <tt>[
+"development", "test"]</tt>. Overridden with <tt>cartage --without
+group1,group2</tt>.
+
+    without:
+      - development
+      - test
+      - other
+
+=== +plugins+
+
+A dictionary that contains all plug-in configuration, keyed by plug-in name.
+
+== Cartage Plug-In Configuration Options
+
+=== cartage-s3
+
+Cartage-s3 needs to know where to put the completed package and how to log into
+the selected storage provider.
+
+==== +path+
+
+The path to the cartage S3 bucket or directory (for another service that
+Fog::Storage supports). This has no default and is overridden with <tt>cartage
+s3 --path PATH</tt>.
+
+    plugins:
+      s3:
+        path: cartage-bucket
+
+==== +credentials+
+
+The credentials dictionary passed to Fog::Storage for uploads. Each provider
+has different keys. If present, this will dictionary be used in preference to
+<tt>cartage s3</tt> flags <tt>--key-id</tt>, <tt>--secret-key</tt>, and
+<tt>--region</tt> as those work *only* with Amazon AWS S3.
+
+===== AWS
+
+AWS S3 storage connections need +provider+, +aws_access_key_id+,
++aws_secret_access_key+, and +region+.
+
+    plugins:
+      s3:
+        credentials:
+          provider: AWS
+          aws_access_key_id: YOUR_AWS_ACCESS_KEY_ID
+          aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
+          region: us-west-2
+
+===== Rackspace
+
+Rackspace storage connections need +provider+, +rackspace_username+,
++rackspace_api_key+, and optionally +rackspace_auth_url+.
+
+    plugins:
+      s3:
+        credentials:
+          provider: Rackspace
+          rackspace_username: RACKSPACE_USERNAME
+          rackspace_api_key: RACKSPACE_API_KEY
+          rackspace_auth_url: lon.auth.api.rackspacecloud.com
+
+===== Google
+
+Google storage connections need +provider+, +google_storage_access_key_id+, and
++google_storage_secret_access_key+.
+
+    plugins:
+      s3:
+        credentials:
+          provider: Google
+          google_storage_access_key_id: YOUR_SECRET_ACCESS_KEY_ID
+          google_storage_secret_access_key: YOUR_SECRET_ACCESS_KEY
+
+=== cartage-remote
+
+Cartage-remote needs to know where its remote build is going to run and how to
+authenticate. It may also be told *what* to run. For cartage-remote 1.0, the
++remote+ configuration section is *required* (at least the +server+ key).
+
+==== +server+
+
+The name of the build server. This field is required and can show up in two
+different formats. The first is as a string matching
+<tt>[user@]host[:port]</tt>.
+
+    plugins:
+      remote:
+        server: build@my-build-machine:2222
+
+The second is as a dictionary with +user+, +host+, and +port+ keys.
+
+    plugins:
+      remote:
+        server:
+          user: build
+          host: my-build-machine
+          port: 2222
+
+==== +keys+
+
+The SSH key(s) used to connect to the server. Optional, and cartage-remote will
+use <tt>~/.ssh/*id_[rd]sa</tt> to find keys if this is not provided. The first
+format is as a dictionary, embedding private keys directly in the configuration
+file.
+
+    plugins:
+      remote:
+        keys:
+          custom: |
+            -----BEGIN RSA PRIVATE KEY-----
+            ...
+            -----END RSA PRIVATE KEY-----
+
+The second form is as an array of glob patterns to match key files.
+
+    plugins:
+      remote:
+        keys:
+          - "config/secrets/*id_[rd]sa"
+          - "~/.ssh/*id_[rd]sa"
+
+The third form is as a single glob pattern to match key files or a specific key
+file.
+
+    plugins:
+      remote:
+        keys: "config/secrets/*id_[rd]sa"
+
+==== +build+
+
+The build script that will be run on the remote server. This is optional with a
+reasonable default, below.
+
+    #!/bin/bash
+    set -e
+    if [ -f Gemfile ]; then
+      bundle install --path %<remote_bundle>s
+      bundle exec cartage build \
+        --config-file %<config_file>s \
+        --target %<project_path>s
+    else
+      cartage build --config-file %<config_file>s \
+        --target %<project_path>s
+    fi
+
+An example with an alternate build script that uses cartage-s3 to upload.
+
+    plugins:
+      remote:
+        build: |
+          #!/bin/bash
+          set -e
+          if [ -f Gemfile ]; then
+            bundle install --path %<remote_bundle>s
+            bundle exec cartage s3 \
+              --config-file %<config_file>s \
+              --target %<project_path>s \
+              --verbose
+          else
+            cartage build \
+              --config-file %<config_file>s \
+              --target %<project_path>s \
+              --verbose
+          fi
+
+==== +prebuild+
+
+The prebuild script that will be run on the local system. This is optional with
+a reasonable default, below:
+
+    #!/bin/bash
+    ssh-keyscan -H %<remote_host>s >> ~/.ssh/known_hosts
+
+An example with a slightly extended example is below. It is strongly
+recommended that the <tt>ssh-keyscan</tt> step be run in all prebuild scripts
+as cartage-remote runs SSH in a paranoid mode.
+
+    plugins:
+      remote:
+        prebuild: |
+          #!/bin/bash
+          ssh-keyscan -H %<remote_host>s >> ~/.ssh/known_hosts
+          echo 'Prebuild complete'
+
+==== +postbuild+
+
+The postbuild script that will be run on the local system. This is optional
+with no default (no post-build actions).
+
+An example that posts a message to Slack is below.
+
+    plugins:
+      remote:
+        postbuild: |
+          #!/bin/bash
+          t="token=SLACK_TOKEN"
+          c="channel=%23ci"
+          d=MYDOMAIN
+          u="https://${d}.slack.com/services/hooks/slackbot?${t}&${c}"
+          curl --data "Build %<name>s-%<timestamp>s complete." ${u}

data/Contributing.rdoc

@@ -0,0 +1,66 @@
+== Contributing
+
+We value any contribution to cartage you can provide: a bug report, a feature
+request, or code contributions.
+
+Cartage is reasonably complex code, so there are a few guidelines:
+
+* Changes *will* *not* be accepted without tests. The test suite is written
+  with {Minitest}[https://github.com/seattlerb/minitest].
+* Match our coding style.
+* Use a thoughtfully-named topic branch that contains your change. Rebase your
+  commits into logical chunks as necessary.
+* Use {quality commit messages}[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html].
+* Do not change the version number; when your patch is accepted and a release
+  is made, the version will be updated at that point.
+* Submit a GitHub pull request with your changes.
+* New behaviours and features are probably better created as cartage plugins.
+  If they are best suited for the core Cartage features, they require new or
+  updated documentation.
+
+=== Test Dependencies
+
+Cartage uses Ryan Davis’s {Hoe}[https://github.com/seattlerb/hoe] to manage the
+release process, and it adds a number of rake tasks. You will mostly be
+interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for
+cartage, I have provided the simplest possible Gemfile pointing to
+the (generated) +cartage.gemspec+ file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have +hoe+ installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+=== Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+* Fork the project.
+* Clone down your fork (<tt>git clone git://github.com/KineticCafe/cartage.git</tt>).
+* Create a topic branch to contain your change (<tt>git checkout -b my\_awesome\_feature</tt>).
+* Hack away, add tests. Not necessarily in that order.
+* Make sure everything still passes by running +rake+.
+* If necessary, rebase your commits into logical chunks, without errors.
+* Push the branch up (<tt>git push origin my\_awesome\_feature</tt>).
+* Create a pull request against KineticCafe/cartage and describe
+  what your change does and the why you think it should be merged.
+
+=== Contributors
+
+* Austin Ziegler created Cartage.

data/Gemfile

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+
+# NOTE: This file is not the canonical source of dependencies. Edit the
+# Rakefile, instead.
+
+source "https://rubygems.org/"
+gemspec
+
+# vim: syntax=ruby

data/History.rdoc

@@ -0,0 +1,5 @@
+=== 1.0 / 2015-03-24
+
+*   1 major enhancement
+
+    *   Birthday!

data/Licence.rdoc

@@ -0,0 +1,27 @@
+== Licence
+
+This software is available under an MIT-style licence.
+
+* Copyright 2015 Kinetic Cafe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+* The names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,24 @@
+.autotest
+.gemtest
+.minitest.rb
+.travis.yml
+Cartage.yml.rdoc
+Contributing.rdoc
+Gemfile
+History.rdoc
+Licence.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/cartage
+cartage.yml.sample
+lib/cartage.rb
+lib/cartage/command.rb
+lib/cartage/config.rb
+lib/cartage/manifest.rb
+lib/cartage/manifest/commands.rb
+lib/cartage/pack_command.rb
+lib/cartage/plugin.rb
+test/minitest_config.rb
+test/test_cartage.rb
+test/test_cartage_config.rb