environments-list-builder 0.1.8 → 0.1.9

data/LICENSE.txt

@@ -0,0 +1,203 @@
+Copyright (c) 2014 Christo De Lange
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,2 @@
+ore-apachev2
+============

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w[--format pretty]
+end

data/bin/environmentslistbuilder

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+path = File.dirname(__FILE__)
+if File.exists?("#{path}/../.gitignore")
+  %w(chefrepo-builder cicd-builder).each do |mod|
+    add_path = File.expand_path(File.join(path, "../../#{mod}", "lib"))
+    $:.unshift(add_path)
+  end
+else
+  # Borrowing from "whiches" gem ...
+  cmd  = File.basename(__FILE__, '.rb')
+  exes = []
+  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  ENV['PATH'].split(File::PATH_SEPARATOR).each do |pth|
+    exts.each { |ext|
+      exe = File.join(pth, "#{cmd}#{ext}")
+      exes << exe if File.executable? exe
+    }
+  end
+  if exes.size > 0
+    path = File.dirname(exes[0])
+  end
+
+end
+add_path = File.expand_path(File.join(path, "..", "lib"))
+$:.unshift(add_path)
+
+require 'dldinternet/mixlib/logging'
+require 'cicd/builder/environments-list'
+
+# =====================================================================================================================
+exit CiCd::Builder::EnvironmentsList::Runner.new().run()

data/environments-list-builder.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/cicd/builder/environments-list/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'environments-list-builder'
+  gem.version       = CiCd::Builder::EnvironmentsList::VERSION
+  gem.summary       = %q{Jenkins builder task for CI/CD}
+  gem.description   = %q{Jenkins builder of the environments manifest for Continuous Integration/Continuous Delivery artifact promotion style deployments}
+  gem.license       = "Apachev2"
+  gem.authors       = ["Christo De Lange"]
+  gem.email         = "rubygems@dldinternet.com"
+  gem.homepage      = "https://rubygems.org/gems/environments-list-builder"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'manifest-builder', '>= 0.6.9', '< 1.1'
+  gem.add_dependency 'json', '>= 1.8.1', '< 1.9'
+  gem.add_dependency 's3etag', '>= 0.0.1', '< 0.1.0'
+  gem.add_dependency 'archive-tar-minitar', '= 0.5.2'
+  gem.add_dependency 'hashie', '>= 2.1.2', '< 3.5'
+  gem.add_dependency 'awesome_print'
+  gem.add_dependency 'colorize'
+  gem.add_dependency 'inifile'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'aws-sdk', '>= 2.0', '< 2.1'
+  gem.add_dependency 'dldinternet-mixlib-logging'
+
+  gem.add_development_dependency 'bundler', '>= 1.7', '< 2.0'
+  gem.add_development_dependency 'rake', '>= 10.3', '< 11'
+  gem.add_development_dependency 'rubygems-tasks', '>= 0.2', '< 1.1'
+  gem.add_development_dependency 'cucumber', '>= 0.10.7', '< 0.11'
+  gem.add_development_dependency 'rspec', '>= 2.99', '< 3.0'
+end

data/features/manifestrepo-builder.feature

@@ -0,0 +1 @@
+Feature: Blah blah blah

data/features/step_definitions/manifestrepo-builder_steps.rb

@@ -0,0 +1 @@
+@wip

data/lib/cicd/builder/environments-list.rb

@@ -0,0 +1,50 @@
+require 'cicd/builder/manifest'
+
+module CiCd
+  module Builder
+    _lib=File.dirname(__FILE__)
+    $:.unshift(_lib) unless $:.include?(_lib)
+
+    require 'cicd/builder/environments-list/version'
+
+    module EnvironmentsList
+      class Runner < Manifest::Runner
+        require 'cicd/builder/environments-list/mixlib/build'
+        include CiCd::Builder::EnvironmentsList::Build
+        require 'cicd/builder/environments-list/mixlib/repo'
+        include CiCd::Builder::EnvironmentsList::Repo
+
+        # ---------------------------------------------------------------------------------------------------------------
+        def initialize()
+          super
+          @klass = 'CiCd::Builder::EnvironmentsList'
+          @default_options[:builder] = VERSION
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------
+        def getBuilderVersion
+          {
+              version:  VERSION,
+              major:    MAJOR,
+              minor:    MINOR,
+              patch:    PATCH,
+          }
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------
+        def setup()
+          $stdout.write("EnvironmentsListBuilder v#{CiCd::Builder::EnvironmentsList::VERSION}\n")
+          @default_options[:env_keys] << %w(
+                                            REPO_PRODUCTS
+                                            ARTIFACTORY_RELEASE_REPO
+                                            ARTIFACTORY_ENVIRONMENTS_MODULE
+                                           )
+          @default_options[:env_keys] = @default_options[:env_keys].select{|key| key !~ /^CLASSES/}
+          super
+        end
+
+      end
+    end
+
+  end
+end

data/lib/cicd/builder/environments-list/mixlib/build.rb

@@ -0,0 +1,163 @@
+module CiCd
+  module Builder
+    # noinspection RubySuperCallWithoutSuperclassInspection
+    module EnvironmentsList
+      CLASS = 'CiCd::Builder::EnvironmentsList'
+      module Build
+
+        alias_method :super_prepareBuild, :prepareBuild
+        # ---------------------------------------------------------------------------------------------------------------
+        # noinspection RubyHashKeysTypesInspection
+        def prepareBuild()
+          @logger.step CLASS+'::'+__method__.to_s
+          # self.class.superclass.instance_method(:prepareBuild).bind(self).call()
+          super_prepareBuild
+          if 0 == @vars[:return_code]
+            @vars[:components] = {}
+            @vars[:artifacts] = []
+            # Now we need to pull the current environments list
+            # Get the repo a little earlier than the typical build which uses it as a write target iso a read source
+            getRepoInstance('Artifactory')
+            if 0 == @vars[:return_code]
+              getLatestEnvironments()
+            end
+          end
+
+          @vars[:return_code]
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------
+        def getLatestEnvironments(oldver=nil)
+          version = @repo.latestArtifactoryVersion(ENV['ARTIFACTORY_ENVIRONMENTS_MODULE'], ENV['ARTIFACTORY_RELEASE_REPO'])
+          if version
+            if version != oldver
+              objects = @repo.maybeArtifactoryObject(ENV['ARTIFACTORY_ENVIRONMENTS_MODULE'], version, false, ENV['ARTIFACTORY_RELEASE_REPO'])
+              if objects and objects.size > 0
+                if objects.size > 1
+                  @logger.error "Too many versions found for #{ENV['ARTIFACTORY_RELEASE_REPO']}/#{ENV['ARTIFACTORY_ENVIRONMENTS_MODULE']}-#{version} during preparation?"
+                  @vars[:return_code] = Errors::ARTIFACT_MULTI_MATCH
+                else
+                  require 'hashie'
+                  filename = objects[0].download()
+                  @vars[:environments] = {
+                      file: filename,
+                      # artifact: objects[0],
+                      version: version,
+                      changed: false,
+                  }
+                  data = IO.read(filename)
+                  json = begin
+                    JSON.parse(data)
+                  rescue
+                    eval(data)
+                  end
+                  IO.write(filename, JSON.pretty_generate(json, {indent: "\t", space: ' '})) # Just to be tidy :)
+                  @vars[:environments][:data] = Hashie::Mash.new(json)
+                  @logger.info "#{ENV['ARTIFACTORY_ENVIRONMENTS_MODULE']}-#{version}"
+                end
+              else
+                @logger.error "Version not found for #{ENV['ARTIFACTORY_RELEASE_REPO']}/#{ENV['ARTIFACTORY_ENVIRONMENTS_MODULE']}-#{version} during preparation?"
+                @vars[:return_code] = Errors::ARTIFACT_NOT_FOUND
+              end
+            else
+              @logger.info "Alread have the latest version (#{oldver})"
+            end
+          else
+            @logger.error "No version found for #{ENV['ARTIFACTORY_RELEASE_REPO']}/#{ENV['ARTIFACTORY_ENVIRONMENTS_MODULE']} during preparation?"
+            @vars[:return_code] = Errors::ARTIFACT_NOT_FOUND
+          end
+          @vars[:return_code]
+        end
+
+        alias_method :super_cleanupBuild, :cleanupBuild
+        # ---------------------------------------------------------------------------------------------------------------
+        def cleanupAfterUpload()
+          @logger.step CLASS+'::'+__method__.to_s
+          if @vars[:environments] and @vars[:environments][:file]
+            FileUtils.rm_rf(File.dirname(@vars[:environments][:file]))
+          end
+          0
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------
+        def packageBuild()
+          @logger.info CLASS+'::'+__method__.to_s
+          if @vars.has_key?(:environments) and not @vars[:environments].empty?
+            @vars[:return_code] = 0
+            # Now comes the fun part  ... get the list of profiles/credentials and use AWS SDK to discover environments
+            # Let's reuse some code we already have and wrap it in a class
+            begin
+              require_relative 'lib/update_bucket_policy'
+              helper = UpdateBucketPolicy.new
+              helper.logger = @logger
+              helper.options = Hashie::Mash.new(helper.options.to_hash)
+              helper.options[:iniglob]  = ENV['AWS_INI_GLOB'] if ENV['AWS_INI_GLOB']
+              helper.options[:inifile]  = ENV['AWS_INI_FILE'] if ENV['AWS_INI_FILE']
+              helper.options[:profile]  = ENV['AWS_PROFILE']  if ENV['AWS_PROFILE']
+              helper.options[:profiles] = ENV['AWS_PROFILES'] if ENV['AWS_PROFILES']
+              helper.prepare_accounts
+              if helper.accounts.size > 0
+                helper.get_environments()
+                if helper.environments.size > 0
+                  getLatestEnvironments(@vars[:environments][:version])
+                  if 0 == @vars[:return_code]
+                    environments = Hashie::Mash.new(@vars[:environments][:data])
+                    exclude_regex = ENV['ENVS_EXCLUDE_REGEX'] || '-repo'
+                    helper.environments.select{|e,_| e !~ /#{exclude_regex}/ }.each do |envnam,_|
+                      environments[envnam] ||= {}
+                    end
+                    if environments.size != @vars[:environments][:data].size
+                      IO.write(@vars[:environments][:file], JSON.pretty_generate(environments.to_hash, {indent: "\t", space: ' '}))
+                      @vars[:environments][:changed] = true
+                    end
+                  end
+                end
+              else
+                @logger.error 'No AWS accounts found during preparation?'
+                @vars[:return_code] = Errors::NO_ACCOUNTS
+              end
+            rescue => e
+              @logger.fatal "#{e.message}\n#{e.backtrace}"
+              @vars[:return_code] = Errors::NO_ACCOUNTS
+            end
+          else
+            @logger.error 'No components found during preparation?'
+            @vars[:return_code] = Errors::NO_COMPONENTS
+          end
+          @vars[:return_code]
+        end
+
+        protected
+
+        def prepare_accounts
+          @accounts = []
+          if @options[:iniglob]
+            iniglob = File.expand_path(@options[:iniglob])
+            Dir.glob( iniglob) {| filename |
+              @accounts << IniFileCredentials.new(filename)
+            }
+          elsif @options[:inifile]
+            @accounts << IniFileCredentials.new(@options[:inifile]) unless (@options[:inifile].nil? or @options[:inifile].empty?)
+          end
+
+          if @options[:profiles]
+            @options[:profiles].each {| profile |
+              @accounts << ProfileCredentials.new(profile)
+            }
+          end
+          unless @accounts.size > 0
+            parse_options
+            logger.fatal 'No options allow for account identification'
+          end
+          # Make the options mutable
+          opts = @options.dup
+          @options = Hash.new()
+          opts.each do |k,v|
+            @options[k.to_sym] = v
+          end
+        end
+
+      end
+    end
+  end
+end