puppet-armature 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c583eeec96331a7050861894eead4b88bdd0a4d
-  data.tar.gz: 1a69219101f220fbb501c3fc9a241881c193cd3b
+SHA256:
+  metadata.gz: 36a266d3305f422219a9eaf907a09dabf8f20ec1a873d4d83287dc5803b689da
+  data.tar.gz: d2a08d0fd13a15eafccd593b008e85a0fab4836b5dce1e029054880a8413d5a6
 SHA512:
-  metadata.gz: 4278d3ff34d1bb711b47cd5088eb7f48c05c2c57a62c4f111d370d44c7f9b25044d4adca2a01b84f197884efb20e41ef3fe34eb00d41653786afa5bf0f491aef
-  data.tar.gz: 5210242988bb7fb870f7375b1a1dcdf0e0b3c74750d40136804c79531623bd1e265edcd2a097d0dc0fed2956d6363225e6ea141b4ed55a8969b540ddc11dbbfa
+  metadata.gz: 35a11fbaa894fe37e062238a0e5ca3d8f249e621163c638aabde40f7bf50afc79cc0c31cdd256e42b8eea42d235f3913f3131f2edd0738cb840cf3fa4c8745ca
+  data.tar.gz: 9b065e837cb6cdd6330a634be60793b08a7d6b30ef17ad4ed075e06097d414be4abc143b7ea50e8b081ca8b5c58226f32d8cddd6f8667e8d6f7137dc9ef08bf4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puppet-armature (0.4.0)
+    puppet-armature (0.5.0)
       gli (= 2.14.0)
       logging (~> 2)
 
@@ -15,6 +15,7 @@ GEM
       multi_json (~> 1.10)
     minitest (5.10.1)
     multi_json (1.13.1)
+    rake (12.3.2)
 
 PLATFORMS
   ruby
@@ -23,6 +24,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.9)
   puppet-armature!
+  rake
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -38,6 +38,10 @@ options, or `armature help <command>` to learn about a specific command.
 
 Deploys branches from a git repository as environments.
 
+### `armature deploy-puppetfile`
+
+Deploys the Puppetfile in the current directory into `./modules`.
+
 ### `armature update`
 
 Updates all branches in the cache. This will update all environments to their

data/bin/armature

@@ -110,6 +110,29 @@ command "deploy-branches" do |c|
   end
 end
 
+desc 'Deploy ./Puppetfile into ./modules'
+long_desc 'By default this deploys the Puppetfile in the current directory into
+  ./modules.
+
+  You may specify another directory to use instead of the current directory.
+  It\'s equivalent to cding into the other directory and then running
+  `armature deploy-puppetfile`.'
+arg 'SOURCE-DIRECTORY', :optional
+command "deploy-puppetfile" do |c|
+  c.action do |global_options, options, arguments|
+    @cache.lock File::LOCK_SH do
+      puppetfile = Armature::Puppetfile.new(@cache)
+
+      source_directory = arguments[0] || "."
+      if ! puppetfile.load_control_directory(source_directory)
+        abort() # A warning is displayed in load_control_directory()
+      end
+
+      puppetfile.update_modules(source_directory)
+    end
+  end
+end
+
 desc 'Remove unused objects from cache'
 command :gc do |c|
   c.action { @cache.garbage_collect(@environments_path) }

data/docs/puppetfile-syntax.md

@@ -2,11 +2,6 @@
 
 The Puppetfile is just ruby. There are a few important declarations:
 
-### `forge 'https://forge.puppet.com'`
-
-This specifies what “forge” to use. You don't need to specify this unless you
-have a caching proxy, or your own Forge-like web site.
-
 ### `mod 'owner-name', 'version'`
 
 Install a module from the Forge. This will use whatever “forge” was last set
@@ -39,6 +34,16 @@ one, it will default to the master branch.
 You can also use `:ref` to specify any of the above, or another type of git
 ref. Using this will cause armature to check for updates on every deploy.
 
+### `forge 'https://forge.puppet.com'`
+
+This specifies what “forge” to use. You don't need to specify this unless you
+have a caching proxy, or your own Forge-like web site.
+
+### `moduledir 'modules'`
+
+What directory should the modules go in? You should almost never need to
+specify this.
+
 ## Example
 
 ~~~ ruby

data/lib/armature/environments.rb

@@ -82,18 +82,9 @@ module Armature
           return
         end
 
-        puppetfile_path = "#{ref_path}/Puppetfile"
-        if File.exist?(puppetfile_path)
-          @logger.debug "Found Puppetfile in environment '#{name}'"
-          module_refs = Armature::Puppetfile.new(@cache).include(puppetfile_path)
-          @logger.debug "Loaded Puppetfile in environment '#{name}' with" \
-            " #{module_refs.length} modules"
-        else
-          @logger.debug "No Puppetfile in environment '#{name}'"
-          module_refs = {}
-        end
-
-        update_modules(ref_path, module_refs)
+        puppetfile = Armature::Puppetfile.new(@cache)
+        puppetfile.load_control_directory(ref_path)
+        puppetfile.update_modules(ref_path)
 
         # Make the change live
         @cache.atomic_symlink(ref_path, "#{@path}/#{name}")
@@ -101,31 +92,5 @@ module Armature
           " environment '#{name}'"
       end
     end
-
-  private
-
-    # Apply the results of the Puppetfile to a ref (e.g. an environment)
-    #
-    ### FIXME This could update modules in an existing check out.
-    def update_modules(target_path, module_refs)
-      modules_path = "#{target_path}/modules"
-      if ! Dir.exist? modules_path
-        Dir.mkdir(modules_path)
-      end
-
-      module_refs.each do |name, info|
-        self.class.assert_valid_module_name(name)
-
-        ref_path = info[:ref].check_out()
-        @cache.atomic_symlink(ref_path, "#{modules_path}/#{name}")
-      end
-
-      Dir.foreach(modules_path) do |name|
-        if ! module_refs.has_key? name and name != "." and name != ".."
-          # All paths should be symlinks.
-          File.delete("#{modules_path}/#{name}")
-        end
-      end
-    end
   end
 end

data/lib/armature/puppetfile.rb

@@ -7,6 +7,21 @@ module Armature
       @results = {}
       @logger = Logging.logger[self]
       @forge_url = "https://forge.puppet.com"
+      @moduledir = 'modules'
+    end
+
+    def load_control_directory(control_directory)
+      puppetfile_path = "#{control_directory}/Puppetfile"
+      if File.exist?(puppetfile_path)
+        @logger.debug "Found #{puppetfile_path}"
+        include(puppetfile_path)
+        @logger.debug "Loaded #{puppetfile_path}: #{@results.length} modules"
+        return true
+      else
+        @logger.warn "#{puppetfile_path} does not exist"
+        @results = {}
+        return false
+      end
     end
 
     ### FIXME this will have access to @cache and @results
@@ -15,10 +30,38 @@ module Armature
       @results
     end
 
+    # Apply the results of the Puppetfile to a ref (e.g. an environment)
+    #
+    ### FIXME This could update modules in an existing check out.
+    def update_modules(target_path, module_refs=@results)
+      modules_path = "#{target_path}/#{@moduledir}"
+      if ! Dir.exist? modules_path
+        Dir.mkdir(modules_path)
+      end
+
+      module_refs.each do |name, info|
+        Armature::Environments.assert_valid_module_name(name)
+
+        ref_path = info[:ref].check_out()
+        @cache.atomic_symlink(ref_path, "#{modules_path}/#{name}")
+      end
+
+      Dir.foreach(modules_path) do |name|
+        if ! module_refs.has_key? name and name != "." and name != ".."
+          # All paths should be symlinks.
+          File.delete("#{modules_path}/#{name}")
+        end
+      end
+    end
+
     def forge(url)
       @forge_url = url.chomp("/")
     end
 
+    def moduledir(path)
+      @moduledir = path
+    end
+
     def mod(full_name, options={})
       name = full_name.split("-", 2).last()
       Armature::Environments.assert_valid_module_name(name)

data/lib/armature/run.rb

@@ -48,6 +48,14 @@ module Armature::Run
       logger.debug("Run with input: " + command_to_string(cmd))
     end
 
+    # The default doesn't really do anything; it's just there for a little
+    # clarity. If we're passed an environment, it will be a Hash. Otherwise,
+    # `environment` captured the first value in cmd.
+    if ! environment.kind_of?(Hash)
+      cmd.unshift(environment)
+      environment = {}
+    end
+
     start_time = Time.now
     output, status = nil, nil
     Open3.popen2e(environment, *cmd) do |pipe_in, pipe_out, promise|

data/lib/armature/version.rb

@@ -1,4 +1,4 @@
 module Armature
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
   HOMEPAGE = "https://github.com/danielparks/armature"
 end

data/puppet-armature.gemspec

@@ -16,13 +16,13 @@ spec = Gem::Specification.new do |s|
     It is designed as a much faster replacement for r10k, though it does not
     have all of r10k's features.
   EOF
-  s.files = `git ls-files`.split("\n")
+  s.files = `git ls-files`.split("\n") - [".gitignore"]
   s.require_paths << 'lib'
-  s.has_rdoc = false
   s.bindir = 'bin'
   s.executables << 'armature'
   s.required_ruby_version = '>= 2.0.0'
   s.add_runtime_dependency('gli','2.14.0')
   s.add_runtime_dependency('logging','~> 2')
   s.add_development_dependency('minitest','~> 5.9')
+  s.add_development_dependency('rake','<999')
 end

data/test/{deploy_test.rb → environment_deploy_test.rb}

@@ -1,11 +1,11 @@
 require 'minitest/autorun'
 require 'helpers'
 
-class DeployTest < Minitest::Test
+class EnvironmentDeployTest < Minitest::Test
   include ArmatureTestHelpers
 
   def test_deploy_just_master_branch
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       branches = Set.new(repo.get_branches())
 
@@ -27,7 +27,7 @@ class DeployTest < Minitest::Test
 
   ### FIXME: should this generate an error?
   def test_deploy_nonexistant_branch
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       branches = Set.new(repo.get_branches())
 
@@ -42,7 +42,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_deploy_all_branches
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       branches = Set.new(repo.get_branches())
 
@@ -66,7 +66,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_deploy_one_module
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       @environments.check_out_ref(repo, "master")
 
@@ -78,7 +78,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_adding_module_and_redeploying
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       @environments.check_out_ref(repo, "master")
 
@@ -108,7 +108,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_removing_module_and_redeploying
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       @environments.check_out_ref(repo, "master")
 
@@ -128,7 +128,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_module_with_bad_ref
-    with_context do
+    with_environment_context do
       repo_commit("control", "Set module-1 to bad ref") do
         File.write("Puppetfile", <<-PUPPETFILE)
           forge "https://forge.puppet.com"
@@ -152,7 +152,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_bad_ref
-    with_context do
+    with_environment_context do
       repo = Armature::Repo::Git::from_url(@cache, repo_path("control"))
       @environments.check_out_ref(repo, "master")
 
@@ -169,18 +169,14 @@ class DeployTest < Minitest::Test
         @environments.check_out_ref(repo, "master")
       end
 
-      ### FIXME state of repo after an error is undefined
       ### What happens if other modules already exist?
-      skip("state of repo after an error is undefined")
-      assert_equal(
-        [".", "..", "module1"].sort(),
-        Dir.entries(@environments.path + "/master/modules").sort(),
-        "Modules installed after test incorrect")
+      assert(! File.directory?(@environments.path + "/master/modules"),
+        "Incorrectly created modules directory")
     end
   end
 
   def test_redeploying_module_with_ref_tag
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("ref", "tag_one") do
         assert_module_manifests("interesting", ["one.pp"],
@@ -190,7 +186,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_ref_branch
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("ref", "branch_two") do
         assert_module_manifests("interesting", ["one.pp", "two.pp", "two_a.pp"],
@@ -200,7 +196,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_ref_commit
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       sha = repo_git("interesting", "rev-parse", "branch_two^").chomp
       redeploy_module_with_ref_of_type("ref", sha) do
@@ -211,7 +207,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_tag
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("tag", "tag_one") do
         assert_module_manifests("interesting", ["one.pp"],
@@ -221,7 +217,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_branch
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("branch", "branch_two") do
         assert_module_manifests("interesting", ["one.pp", "two.pp", "two_a.pp"],
@@ -231,7 +227,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_commit
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       sha = repo_git("interesting", "rev-parse", "branch_two^").chomp
       redeploy_module_with_ref_of_type("commit", sha) do
@@ -242,7 +238,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_redeploying_module_with_updated_branch
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("ref", "branch_two") do
         repo_git("interesting", "checkout", "branch_two")
@@ -259,7 +255,7 @@ class DeployTest < Minitest::Test
   end
 
   def test_updating_branches_on_module_with_updated_branch
-    with_context do
+    with_environment_context do
       set_up_interesting_module("interesting")
       redeploy_module_with_ref_of_type("ref", "branch_two") do
         repo_git("interesting", "checkout", "branch_two")

data/test/helpers.rb

@@ -84,11 +84,21 @@ module ArmatureTestHelpers
     with_temp_dir("context") do
       @cache = Armature::Cache.new("cache")
 
+      repo_init("module-1")
+
+      yield
+    end
+  ensure
+    # Ensure that code trying to use these after this point fails in a
+    # predictable way.
+    @cache = nil
+  end
+
+  def with_environment_context
+    with_context do
       Dir.mkdir("environments")
       @environments = Armature::Environments.new("environments", @cache)
 
-      repo_init("module-1")
-
       repo_init("control") do
         File.write("Puppetfile", <<-PUPPETFILE)
           forge "https://forge.puppet.com"
@@ -100,9 +110,6 @@ module ArmatureTestHelpers
       yield
     end
   ensure
-    # Ensure that code trying to use these after this point fails in a
-    # predictable way.
-    @cache = nil
     @environments = nil
   end
 

data/test/puppetfile_deploy_test.rb

@@ -0,0 +1,83 @@
+require 'minitest/autorun'
+require 'helpers'
+
+class PuppetfileDeployTest < Minitest::Test
+  include ArmatureTestHelpers
+
+  def test_deploy_puppetfile
+    with_control do
+			@cache.lock File::LOCK_SH do
+				puppetfile = Armature::Puppetfile.new(@cache)
+				success = puppetfile.load_control_directory("control")
+				assert(success, "Failed to load control/Puppetfile")
+
+				puppetfile.update_modules("control")
+			end
+
+      assert(File.directory?("control/modules"),
+        "Failed to create control/modules")
+      assert_equal(
+        [".", "..", "module1"].sort(),
+        Dir.entries("control/modules").sort(),
+        "Installed modules incorrectly")
+    end
+  end
+
+  def test_deploy_nonexistent_puppetfile
+    with_context do
+    	Dir.mkdir("control")
+
+			@cache.lock File::LOCK_SH do
+				puppetfile = Armature::Puppetfile.new(@cache)
+				success = puppetfile.load_control_directory("control")
+				assert(!success, "Loaded non-existent Puppetfile")
+			end
+
+      assert(! File.directory?("control/modules"),
+        "Incorrectly created control/modules")
+    end
+  end
+
+  def test_deploy_puppetfile_moduledir
+    with_control do
+			File.write("control/Puppetfile", <<-PUPPETFILE)
+				forge "https://forge.puppet.com"
+				moduledir "vendor"
+
+				mod "module1", :git=>"#{repo_path('module-1')}"
+			PUPPETFILE
+
+			@cache.lock File::LOCK_SH do
+				puppetfile = Armature::Puppetfile.new(@cache)
+				success = puppetfile.load_control_directory("control")
+				assert(success, "Failed to load control/Puppetfile")
+
+				puppetfile.update_modules("control")
+			end
+
+      assert(! File.directory?("control/modules"),
+        "Incorrectly created control/modules")
+      assert(File.directory?("control/vendor"),
+        "Failed to create control/vendor")
+      assert_equal(
+        [".", "..", "module1"].sort(),
+        Dir.entries("control/vendor").sort(),
+        "Installed modules incorrectly")
+    end
+  end
+
+private
+
+  def with_control
+    with_context do
+    	Dir.mkdir("control")
+			File.write("control/Puppetfile", <<-PUPPETFILE)
+				forge "https://forge.puppet.com"
+
+				mod "module1", :git=>"#{repo_path('module-1')}"
+			PUPPETFILE
+
+			yield
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-armature
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Parks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
 description: |2
       Armature sets up Puppet environments for each branch in your control repo,
       then installs the modules specified in the Puppetfile for each environment.
@@ -88,8 +102,9 @@ files:
 - lib/armature/util.rb
 - lib/armature/version.rb
 - puppet-armature.gemspec
-- test/deploy_test.rb
+- test/environment_deploy_test.rb
 - test/helpers.rb
+- test/puppetfile_deploy_test.rb
 - test/puppetfile_test.rb
 homepage: https://github.com/danielparks/armature
 licenses:
@@ -111,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Deploy Puppet environments and manage modules