auster 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c4b1f54eb6c85806e15fd5d0c10d084237143c
-  data.tar.gz: 8fc7812b3c331168454559e81780a390214b1ff0
+  metadata.gz: 77f239157bba892dba58bba35d3f6c7f4e9fa962
+  data.tar.gz: 411670ff3bebba164215bfd07993dd9aa6982385
 SHA512:
-  metadata.gz: 74bcbed24f715040cabe0063e56a77f8beeeedd8d3223a3480d2507ffa7f28e35014fb85681f64e169de51993802b91e9d8c92850a463363b98da38bab4ccc12
-  data.tar.gz: 229f261906b6843db306c25a569f9dec2324038b2b0dbb638f04254f7e89199b8644d3b6af02c52d9493aba2692aec3be66b914cf09fbc9b43e6791798be5ff0
+  metadata.gz: 43b2d524317e0332e853b498448acc65651f1854c7a0113531820dc16e9df7bd56b01e428f227495d89d2ddd4c07f115b767b992d3d5e0f0c496c075b4ece481
+  data.tar.gz: e883ec1ddb96733f8722f7af91b3f68a8d95c3f4ce01e60fd7e31252010aa26a1a59960a560ad8e70d50577e6dd2798f7c45659b0f537992b86f27fbc2638ddd

data/README.md

@@ -19,8 +19,8 @@ $ cd auster/example-repo
 Take a look around the repo if you'd like. Ensure that you have valid AWS credentials in your environment (`AWS_PROFILE`, etc.) and then run the following to create a pair of CloudFormation stacks. All they'll do is create S3 buckets, so you won't be charged for anything.
 
 ```bash
-$ auster run us-west-2/dev-ed1 bootstrap
-$ auster run us-west-2/dev-ed1 dependent
+$ auster apply us-west-2/dev-ed1 bootstrap
+$ auster apply us-west-2/dev-ed1 dependent
 ```
 
 If you read through the Auster output, you'll see that it's creating S3 buckets (as you'd expect--it's still CloudFormation under the hood) and registering them as region-wide exports, prefixed with the plan ID `dev1-ed`.
@@ -39,10 +39,10 @@ If you'd like more information on writing Cfer itself, check out [chef-cfer-cons
 - `auster generate step ##.human-tag` - Creates a new Auster step with stub files.
 
 ### Executors ###
-**Note:** In the command line interface, the step number and the tag are interchangeable. `auster run region/env 00` and `auster run region/env human-tag` will refer to the same step, `00.human-tag`.
+**Note:** In the command line interface, the step number and the tag are interchangeable. `auster apply region/env 00` and `auster apply region/env human-tag` will refer to the same step, `00.human-tag`.
 
-- `auster json us-west-2/dev1-ed (##|human-tag)` - Uses `cfer generate` to generate the output JSON that will be applied when this step is `auster run`'d.
-- `auster run us-west-2/dev1-ed (##|human-tag)` - Runs step 01 in region `us-west2` with configuration set `dev1-ed`. This will:
+- `auster json us-west-2/dev1-ed (##|human-tag)` - Uses `cfer generate` to generate the output JSON that will be applied when this step is `auster apply`'d.
+- `auster apply us-west-2/dev1-ed (##|human-tag)` - Runs step 01 in region `us-west2` with configuration set `dev1-ed`. This will:
   - If `/cfg/_schema.yaml` exists, it will validate `/cfg/us-west2/dev1-ed.yaml` against it and fail if it does not validate.
   - If this is the first run of this step (there is no `dev1-ed-step01` CloudFormation stack in AWS), the scripts in `/steps/01/on-create.d` will be run in lexicographic order.
   - The scripts in `/steps/01/pre-converge.d` will be run in lexicographic order.

data/example-repo/tasks/show-exports.rb

@@ -0,0 +1 @@
+puts exports.inspect

data/example-repo/tasks/sub/test-script.rb

@@ -0,0 +1 @@
+puts args.inspect

data/example-repo/tasks/test-script1.rb

@@ -0,0 +1 @@
+puts repo.root

data/lib/cfer/auster/cli/apply.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.apply
+        Cri::Command.define do
+          name "apply"
+          usage "apply aws-region/config-set count-or-tag"
+          description "Applies this Auster step against your AWS infrastructure."
+
+          CLI.standard_options(self)
+
+          run do |opts, args, cmd|
+            if args.length < 2
+              puts cmd.help
+              exit 1
+            else
+              CLI.repo_from_options(opts) do |repo|
+                args = args.dup
+                config_set = repo.config_set(args.shift)
+                step = repo.step_by_count_or_tag(args.shift)
+
+                step.apply(config_set)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli/destroy.rb

@@ -20,8 +20,9 @@ module Cfer
               exit 1
             else
               CLI.repo_from_options(opts) do |repo|
-                config_set = repo.config_set(args[0])
-                step = repo.step_by_count_or_tag(args[1])
+                args = args.dup
+                config_set = repo.config_set(args.shift)
+                step = repo.step_by_count_or_tag(args.shift)
 
                 step.destroy(config_set)
               end

data/lib/cfer/auster/cli/json.rb

@@ -24,8 +24,9 @@ module Cfer
               exit 1
             else
               CLI.repo_from_options(opts) do |repo|
-                config_set = repo.config_set(args[0])
-                step = repo.step_by_count_or_tag(args[1])
+                args = args.dup
+                config_set = repo.config_set(args.shift)
+                step = repo.step_by_count_or_tag(args.shift)
 
                 ret = step.json(config_set)
 

data/lib/cfer/auster/cli/nuke.rb

@@ -24,7 +24,8 @@ module Cfer
               exit 1
             else
               CLI.repo_from_options(opts) do |repo|
-                config_set = repo.config_set(args[0])
+                args = args.dup
+                config_set = repo.config_set(args.shift)
 
                 accepted = !!opts[:force]
 

data/lib/cfer/auster/cli/{run.rb → task.rb}

@@ -6,11 +6,11 @@ require "cfer/auster/cli/_shared"
 module Cfer
   module Auster
     module CLI
-      def self.run
+      def self.task
         Cri::Command.define do
-          name "run"
-          usage "run aws-region/config-set count-or-tag"
-          description "Runs this Auster step against your AWS infrastructure."
+          name "task"
+          usage "task aws-region/config-set script-name [args]"
+          description "Runs a task within the context of an Auster config set."
 
           CLI.standard_options(self)
 
@@ -20,10 +20,11 @@ module Cfer
               exit 1
             else
               CLI.repo_from_options(opts) do |repo|
-                config_set = repo.config_set(args[0])
-                step = repo.step_by_count_or_tag(args[1])
+                args = args.dup
+                config_set = repo.config_set(args.shift)
+                task_name = args.shift
 
-                step.run(config_set)
+                repo.run_task(task_name, config_set, args)
               end
             end
           end

data/lib/cfer/auster/cli/tasks.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require "cri"
+
+require "cfer/auster/cli/_shared"
+
+module Cfer
+  module Auster
+    module CLI
+      def self.tasks
+        Cri::Command.define do
+          name "tasks"
+          usage "tasks"
+          description "Prints a list of tasks available in this repo."
+
+          CLI.standard_options(self)
+
+          run do |opts, args, cmd|
+            CLI.repo_from_options(opts) do |repo|
+              repo.tasks.each { |t| puts t }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cfer/auster/cli.rb

@@ -7,8 +7,10 @@ require "cfer/auster"
 require "cfer/auster/cli/_shared"
 require "cfer/auster/cli/generate"
 require "cfer/auster/cli/json"
-require "cfer/auster/cli/run"
+require "cfer/auster/cli/task"
+require "cfer/auster/cli/tasks"
 require "cfer/auster/cli/destroy"
+require "cfer/auster/cli/apply"
 require "cfer/auster/cli/nuke"
 
 module Cfer
@@ -45,7 +47,9 @@ module Cfer
 
         ret.add_command(CLI.generate)
         ret.add_command(CLI.json)
-        ret.add_command(CLI.run)
+        ret.add_command(CLI.task)
+        ret.add_command(CLI.tasks)
+        ret.add_command(CLI.apply)
         ret.add_command(CLI.destroy)
         ret.add_command(CLI.nuke)
 

data/lib/cfer/auster/config.rb

@@ -21,8 +21,6 @@ module Cfer
 
         @data[:PlanID] = @name
         @data[:AWSRegion] = @aws_region
-
-        IceNine.deep_freeze(@data)
       end
 
       def full_name

data/lib/cfer/auster/repo.rb

@@ -73,6 +73,28 @@ module Cfer
         @steps.sort.map(&:last)
       end
 
+      def tasks
+        Dir["#{root}/tasks/**/*.rb"].reject { |f| File.basename(f).start_with?("_") }.map do |f|
+          f.gsub("#{root}/tasks/", "").gsub(/\.rb$/, "")
+        end
+      end
+
+      def run_task(task_name, config_set, args = [])
+        logger.debug "Attempting to run task '#{task_name}'."
+        task_file = "#{root}/tasks/#{task_name}.rb"
+
+        raise "task '#{task_name}' (#{task_file}) doesn't exist." \
+          unless File.file?(task_file)
+
+        Cfer::Auster::ScriptExecutor.new(
+          config_set.env_vars_for_shell.merge(
+            repo: self,
+            config_set: config_set,
+            args: args
+          )
+        ).run(task_file)
+      end
+
       def config_set(id)
         raise "Config set not found with id '#{id}'." unless @config_sets.include?(id)
 

data/lib/cfer/auster/step.rb

@@ -62,7 +62,7 @@ module Cfer
         end
       end
 
-      def run(config_set)
+      def apply(config_set)
         raise "config_set must be a Cfer::Auster::Config." unless config_set.is_a?(Cfer::Auster::Config)
 
         with_cfer(config_set) do |cfer|

data/lib/cfer/auster/version.rb

@@ -1,5 +1,5 @@
 module Cfer
   module Auster
-    VERSION = "0.2.2".freeze
+    VERSION = "0.3.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auster
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ed Ropple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -224,18 +224,24 @@ files:
 - example-repo/steps/01.dependent/on-destroy.d/00-debug.rb
 - example-repo/steps/01.dependent/post-converge.d/00-debug.rb
 - example-repo/steps/01.dependent/pre-converge.d/00-debug.rb
+- example-repo/tasks/show-exports.rb
+- example-repo/tasks/sub/_omitted.rb
+- example-repo/tasks/sub/test-script.rb
+- example-repo/tasks/test-script1.rb
 - lib/cfer/auster.rb
 - lib/cfer/auster/cfer_evaluator.rb
 - lib/cfer/auster/cfer_helpers.rb
 - lib/cfer/auster/cli.rb
 - lib/cfer/auster/cli/_shared.rb
+- lib/cfer/auster/cli/apply.rb
 - lib/cfer/auster/cli/destroy.rb
 - lib/cfer/auster/cli/generate.rb
 - lib/cfer/auster/cli/generate/repo.rb
 - lib/cfer/auster/cli/generate/step.rb
 - lib/cfer/auster/cli/json.rb
 - lib/cfer/auster/cli/nuke.rb
-- lib/cfer/auster/cli/run.rb
+- lib/cfer/auster/cli/task.rb
+- lib/cfer/auster/cli/tasks.rb
 - lib/cfer/auster/config.rb
 - lib/cfer/auster/logging.rb
 - lib/cfer/auster/param_validator.rb