ra10ke 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed7cf2819431d671a0b16c4437b8cdc5606be3b7f81660ca63b75b6498f33859
-  data.tar.gz: 0ff570951916a4c267eb09b9f479c68c890cc121666ee1ae94a1f6cfa0b99575
+  metadata.gz: 6b40e69bd38407cb3c0e54c36a83cdc1699ac85ea8512118275bce2f9e8dc6ef
+  data.tar.gz: 4cedb006d2cf6591280e75df20fcf33ba4abdd5f8647caf68497f13c53c05f36
 SHA512:
-  metadata.gz: eea68a63d23b37b4e38a70c167837f84600a91c6d68080f04d288fd17a376e7d6e060f25e7d0d836a4136b8d42a4a7f0b905a135199b08d1468a888deba21a98
-  data.tar.gz: c7446689752cbbd943d8ac4502e103ead5e8499116a43ee099402f24c1d088afc178bb4b3dccb0af6fd4a11d286871fec493fd10f9ea35fb5f030e0c81f1bd47
+  metadata.gz: 0d87d64c5635eb697987a69e3ce56dcb230175f43182ee67e54817da51624c07426ad5f7c82b6f31c896ef88e2ed2132584c5dfc4d085c591e9336fc1d5fc6b3
+  data.tar.gz: 84247260dbf741c18cd0aef1888b40f07328c015b228f1c021ae15c1d8846497819bbe6a6226e51cfe43697e84707c4d0a827f57796a6e73cce76015b354272a

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 CHANGELOG
 =========
 
+1.0.0
+-----
+
+2020-02-08
+
+Closed Pull Requests:
+
+* [#44](https://github.com/voxpupuli/ra10ke/pull/44) - Fix the faulty docs for Ra10ke::Validate#all_refs after [#42](https://github.com/voxpupuli/ra10ke/pull/42)
+* [#45](https://github.com/voxpupuli/ra10ke/pull/45) - Add a duplicates check
+* [#48](https://github.com/voxpupuli/ra10ke/pull/48) - Allow semverse 3.x
+
 0.6.2
 -----
 

data/README.md

@@ -111,7 +111,7 @@ Example
 ```
 NAME     | URL                                           | REF                            | STATUS
 ---------|-----------------------------------------------|--------------------------------|-------
-splunk   | https://github.com/cudgel/splunk.git          | prod                           | 👍
+splunk   | https://github.com/cudgel/splunk.git          | dev                            | 👍
 r10k     | https://github.com/acidprime/r10k             | v3.1.1                         | 👍
 gms      | https://github.com/npwalker/abrader-gms       | gitlab_disable_ssl_verify_s... | 👍
 rbac     | https://github.com/puppetlabs/pltraining-rbac | 2f60e1789a721ce83f8df061e13... | 👍
@@ -123,3 +123,25 @@ gitlab   | https://github.com/vshn/puppet-gitlab         | 00397b86dfb3487d9df76
 👍👍 Puppetfile looks good.👍👍
 ```
 
+### r10k:duplicates
+
+This rake task parses the Puppetfile and looks for modules with duplicate
+declarations.
+
+All found duplicates are reported along with their source and their version
+(if taken from the Forge) or their ref/tag/branch. (if taken from git)
+
+Example
+
+```
+puppet:
+- abstractit/puppet from the forge at version 2.4.1
+- theforeman/puppet from the forge at version 12.0.1
+- puppet from git on the branch master at https://github.com/voxpupuli/puppet-module.git
+
+gitlab:
+- puppet/gitlab from the forge at version 4.0.1
+- gitlab from git on the ref 00397b86dfb3487d9df768cbd3698d362132b5bf at https://github.com/vshn/puppet-gitlab
+
+Error: Duplicates exist in the Puppetfile
+```

data/lib/ra10ke.rb

@@ -4,6 +4,7 @@ require 'ra10ke/version'
 require 'ra10ke/solve'
 require 'ra10ke/syntax'
 require 'ra10ke/dependencies'
+require 'ra10ke/duplicates'
 require 'ra10ke/install'
 require 'ra10ke/validate'
 require 'git'
@@ -14,6 +15,7 @@ module Ra10ke
     include Ra10ke::Solve
     include Ra10ke::Syntax
     include Ra10ke::Dependencies
+    include Ra10ke::Duplicates
     include Ra10ke::Install
     include Ra10ke::Validate
 
@@ -33,6 +35,7 @@ module Ra10ke
         define_task_solve_dependencies(*args)
         define_task_syntax(*args)
         define_task_dependencies(*args)
+        define_task_duplicates(*args)
         define_task_install(*args)
         define_task_validate(*args)
       end

data/lib/ra10ke/duplicates.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'ra10ke/monkey_patches'
+require 'ra10ke/puppetfile_parser'
+
+module Ra10ke::Duplicates
+  def define_task_duplicates(*_args)
+    desc "Check Puppetfile for duplicates"
+    task :duplicates do
+      duplicates = Ra10ke::Duplicates::Verification.new(get_puppetfile.puppetfile_path).duplicates
+      exit_code = 0
+      if duplicates.any?
+        exit_code = 1
+        message = 'Error: Duplicates exist in the Puppetfile'
+
+        duplicates.map do |name, sources|
+          puts "#{name}:"
+          sources.each do |source|
+            puts "- #{source}"
+          end
+
+          puts
+        end
+      else
+        message = 'Puppetfile is free of duplicates'
+      end
+
+      abort(message) if exit_code.positive?
+      puts message
+    end
+  end
+
+  class Verification
+    include Ra10ke::PuppetfileParser
+    Module = Struct.new(:namespace, :name, :args) do
+      def git?
+        args.key? :git
+      end
+
+      def forge?
+        !git?
+      end
+
+      def type
+        git? ? 'git' : 'forge'
+      end
+
+      def to_s
+        str = "#{[namespace, name].compact.join '/'}"
+
+        if git?
+          ref = args[:ref] || args[:tag] || args[:branch]
+          ref_type = (args[:ref] && 'ref') || (args[:tag] && 'tag') || (args[:branch] && 'branch')
+          str += " from git on the #{ref_type} #{ref} at #{args[:git]}"
+        elsif args.key? :version
+          str += " from the forge at version #{args[:version]}"
+        end
+
+        str
+      end
+    end
+
+    attr_reader :puppetfile
+
+    def initialize(file)
+      file ||= './Puppetfile'
+      @puppetfile = File.expand_path(file)
+      abort("Puppetfile does not exist at #{puppetfile}") unless File.readable?(puppetfile)
+    end
+
+    def duplicates
+      to_ret = {}
+      modules(puppetfile).each do |mod|
+        (to_ret[mod[:name]] ||= []) << Module.new(mod[:namespace], mod[:name], mod[:args])
+      end
+      to_ret.select { |_k, v| v.count > 1 }
+    end
+  end
+end

data/lib/ra10ke/validate.rb

@@ -55,14 +55,14 @@ module Ra10ke
         !found.nil?
       end
 
-      # @return [Hash] - a hash of all the refs associated with the remote repository
+      # @return [Array] - an array of all the refs associated with the remote repository
       # @param url [String] - the git string either https or ssh url
       # @example
-      # {"0ec707e431367bbe2752966be8ab915b6f0da754"=>{:ref=>"refs/heads/74110ac", :type=>:branch, :subtype=>nil, :name=>"74110ac"},
-        # "07bb5d2d94db222dca5860eb29c184e8970f36f4"=>{:ref=>"refs/pull/74/head", :type=>:pull, :subtype=>:head, :name=>"74"},
-        # "156ca9a8ea69e056e86355b27d944e59d1b3a1e1"=>{:ref=>"refs/heads/master", :type=>:branch, :subtype=>nil, :name=>"master"},
-        # "fcc0532bbc5a5b65f3941738339e9cc7e3d767ce"=>{:ref=>"refs/pull/249/head", :type=>:pull, :subtype=>:head, :name=>"249"},
-        # "8d54891fa5df75890ee15d53080c2a81b4960f92"=>{:ref=>"refs/pull/267/head", :type=>:pull, :subtype=>:head, :name=>"267"} }
+      #   [{:sha=>"0ec707e431367bbe2752966be8ab915b6f0da754", :ref=>"refs/heads/74110ac", :type=>:branch, :subtype=>nil, :name=>"74110ac"},
+      #     :sha=>"07bb5d2d94db222dca5860eb29c184e8970f36f4", :ref=>"refs/pull/74/head", :type=>:pull, :subtype=>:head, :name=>"74"},
+      #     :sha=>"156ca9a8ea69e056e86355b27d944e59d1b3a1e1", :ref=>"refs/heads/master", :type=>:branch, :subtype=>nil, :name=>"master"},
+      #     :sha=>"fcc0532bbc5a5b65f3941738339e9cc7e3d767ce", :ref=>"refs/pull/249/head", :type=>:pull, :subtype=>:head, :name=>"249"},
+      #     :sha=>"8d54891fa5df75890ee15d53080c2a81b4960f92", :ref=>"refs/pull/267/head", :type=>:pull, :subtype=>:head, :name=>"267"}]
       def all_refs(url)
         data = `git ls-remote --symref #{url}`
         raise "Error downloading #{url}" unless $CHILD_STATUS.success?

data/lib/ra10ke/version.rb

@@ -1,3 +1,3 @@
 module Ra10ke
-  VERSION = "0.6.2"
+  VERSION = "1.0.0"
 end

data/ra10ke.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "r10k"
   spec.add_dependency "git"
   spec.add_dependency "solve"
-  spec.add_dependency 'semverse', '~> 2.0'
+  spec.add_dependency 'semverse', '>= 2.0'
   spec.add_dependency 'table_print', '~> 1.5.6'
   spec.add_development_dependency 'rspec', '~> 3.6'
 end

data/spec/fixtures/Puppetfile

@@ -40,7 +40,7 @@ mod 'dotfiles',
 
 mod 'splunk',
     git: 'https://github.com/cudgel/splunk.git',
-    branch: 'prod'
+    branch: 'dev'
 
 mod 'puppet',
     git: 'https://github.com/voxpupuli/puppet-module.git',

data/spec/fixtures/Puppetfile_with_duplicates

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+forge 'http://forge.puppetlabs.com'
+
+mod 'abstractit/puppet',      '2.4.1'
+mod 'puppet/gitlab',          '4.0.1'
+mod 'puppetlabs/inifile',     '2.2.0'
+mod 'puppetlabs/stdlib',      '4.24.0'
+mod 'puppetlabs/concat',      '4.0.0'
+mod 'puppetlabs/ntp',         '6.4.1'
+mod 'theforeman/puppet',      '12.0.1'
+
+# introduced for tomcat module collaboration with uws
+mod 'puppet-archive', '3.1.1'
+
+mod 'gitlab',
+    git: 'https://github.com/vshn/puppet-gitlab',
+    ref: '00397b86dfb3487d9df768cbd3698d362132b5bf' # master
+
+mod 'r10k',
+    git: 'https://github.com/acidprime/r10k',
+    tag: 'v3.1.1'
+
+mod 'gms',
+    git: 'https://github.com/npwalker/abrader-gms',
+    branch: 'gitlab_disable_ssl_verify_support'
+
+mod 'pltraining-rbac',
+    git: 'https://github.com/puppetlabs/pltraining-rbac',
+    ref: '2f60e1789a721ce83f8df061e13f8bf81cd4e4ce'
+
+mod 'puppet-acl',
+    git: 'https://github.com/dobbymoodge/puppet-acl.git',
+    branch: 'master'
+
+mod 'deploy',
+    git: 'https://github.com/cudgel/deploy.git',
+    branch: 'master'
+
+mod 'dotfiles',
+    git: 'https://github.com/cudgel/puppet-dotfiles.git',
+    branch: 'master'
+
+mod 'splunk',
+    git: 'https://github.com/cudgel/splunk.git',
+    branch: 'dev'
+
+mod 'puppet',
+    git: 'https://github.com/voxpupuli/puppet-module.git',
+    branch: 'master'

data/spec/ra10ke/duplicates_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ra10ke/duplicates'
+RSpec::Mocks.configuration.allow_message_expectations_on_nil = true
+
+RSpec.describe 'Ra10ke::Duplicates::Verification' do
+  let(:instance) do
+    Ra10ke::Duplicates::Verification.new(puppetfile)
+  end
+
+  let(:puppetfile) do
+    File.join(fixtures_dir, 'Puppetfile_with_duplicates')
+  end
+
+  it '#new' do
+    expect(instance).to be_a Ra10ke::Duplicates::Verification
+  end
+
+  it '#duplicates is a hash' do
+    expect(instance.duplicates).to be_a Hash
+  end
+
+  it '#duplicates is a hash with arrays' do
+    expect(instance.duplicates.first.last).to be_a Array
+  end
+
+  it '#duplicates is a hash with arrays containing modules' do
+    expect(instance.duplicates.first.last.first).to be_a Ra10ke::Duplicates::Verification::Module
+  end
+end

data/spec/ra10ke/puppetfile_parser_spec.rb

@@ -43,7 +43,7 @@ RSpec.describe 'Ra10ke::PuppetfileParser' do
                {:branch=>"master", :git=>"https://github.com/cudgel/puppet-dotfiles.git"},
               :name=>"dotfiles",
               :namespace=>nil},
-             {:args=>{:branch=>"prod", :git=>"https://github.com/cudgel/splunk.git"},
+             {:args=>{:branch=>"dev", :git=>"https://github.com/cudgel/splunk.git"},
               :name=>"splunk",
               :namespace=>nil},
              {:args=>{:branch=>"master", :git=>"https://github.com/voxpupuli/puppet-module.git"},
@@ -86,7 +86,7 @@ RSpec.describe 'Ra10ke::PuppetfileParser' do
             {:branch=>"master", :git=>"https://github.com/cudgel/puppet-dotfiles.git"},
            :name=>"dotfiles",
            :namespace=>nil},
-          {:args=>{:branch=>"prod", :git=>"https://github.com/cudgel/splunk.git"},
+          {:args=>{:branch=>"dev", :git=>"https://github.com/cudgel/splunk.git"},
            :name=>"splunk",
            :namespace=>nil},
           {:args=>{:branch=>"master", :git=>"https://github.com/voxpupuli/puppet-module.git"},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ra10ke
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Theo Chatzimichos
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,14 +85,14 @@ dependencies:
   name: semverse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -140,6 +140,7 @@ files:
 - Rakefile
 - lib/ra10ke.rb
 - lib/ra10ke/dependencies.rb
+- lib/ra10ke/duplicates.rb
 - lib/ra10ke/install.rb
 - lib/ra10ke/monkey_patches.rb
 - lib/ra10ke/puppetfile_parser.rb
@@ -151,7 +152,9 @@ files:
 - spec/fixtures/Puppetfile
 - spec/fixtures/Puppetfile_test
 - spec/fixtures/Puppetfile_with_bad_refs
+- spec/fixtures/Puppetfile_with_duplicates
 - spec/fixtures/reflist.txt
+- spec/ra10ke/duplicates_spec.rb
 - spec/ra10ke/puppetfile_parser_spec.rb
 - spec/ra10ke/validate_spec.rb
 - spec/ra10ke_spec.rb