kite 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce668dcff72a31fec89244639d06f41cb92d6210d904077982282f10a6d39f67
-  data.tar.gz: cfca7d98a7654c1c6fb3697b34621994de3832c9fe091c679c9fb7a6bd933f92
+  metadata.gz: 7c516eab6deb826e2384b1002dc82846361159e87682d83f34cff582f32968e6
+  data.tar.gz: d69f8de21c4b59897277b3663467cb044119504528832b6d4a7e85157974bc08
 SHA512:
-  metadata.gz: d16e609a4ef22244c79a23fed8852e631e8ccd0cc4dfadaefe4aec6cd3ed82932c0369f02798ab79e1d366629d0625dd344eac606fa65793eeb28dbd37af2d84
-  data.tar.gz: d3af22b47cbb0761285ed6c3df2a0cc9ba75032239f3ee88436fd0805fcd5c5eafc9ba2d8f3bf9800b696fd6fde5765c2f2efe4958ac22c1c01154a363b0cb99
+  metadata.gz: e3e3ae732aa5096870ab5ebfb3c42c868a0f0ef98a677ce743cd6d5e74eaa775af27173ca9fea21786de05854d3c3328a2ec2b63f07aef53513045b9776ae735
+  data.tar.gz: dd16d0d5991befdbe1659af7677879cbcb075ce3a5e913c8df9024661ddeb5a049a3db61d47e7b7edcea8e62207f2808cecc860b52d481685784f2656636729c

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -1,7 +1,16 @@
-sudo: false
+dist: trusty
+
+sudo: required
+
 language: ruby
-rvm:
-  - 2.4.0
+
+cache: bundler
+
+
 before_install: gem install bundler -v 1.14.6
+
 env:
   COVERAGE: true
+
+# Execute all of the commands which need to be executed after the build passed.
+after_success: ruby ci/bump.rb

data/README.md

@@ -1,12 +1,13 @@
 # Kite
 
-![Build Status](https://ci.helioscloud.com/api/v1/teams/heliostech/pipelines/kite/jobs/build-master/badge)
-[![Build Status](https://travis-ci.org/helios-technologies/kite.svg?branch=master)](https://travis-ci.org/helios-technologies/kite)
-[![codecov](https://codecov.io/gh/helios-technologies/kite/branch/master/graph/badge.svg)](https://codecov.io/gh/helios-technologies/kite)
+[![Gem Version](https://badge.fury.io/rb/kite.svg)](https://badge.fury.io/rb/kite)
+[![license](https://img.shields.io/github/license/rubykube/kite.svg)](https://github.com/rubykube/kite/blob/master/LICENSE.md)
 
+[![Build Status](https://travis-ci.org/rubykube/kite.svg?branch=master)](https://travis-ci.org/rubykube/kite)
+[![codecov](https://codecov.io/gh/rubykube/kite/branch/master/graph/badge.svg)](https://codecov.io/gh/rubykube/kite)
 
 Kite is a CLI for scaffolding and managing devops modules
-The main purpose is templating of various tools for devops around terraform, bosh, ansible
+The main purpose is templating of various tools for devops around terraform, bosh, ansible.
 Currently Kite supports modular stacks(Kite modules) on both AWS and GCP.
 
 We plan in adding community stack using a simple template repository structure.
@@ -31,7 +32,7 @@ Or install it yourself as:
 
 To start using kite for bootstraping your infrastructure
 follow the steps below.
-[Note] Most kite commands can be referred by their first letter(for example kite generate environment test == kite g e test)
+[Note] Most kite commands can be referred by their first letter(for example `kite generate environment test` is the same as `kite g e test`)
 
 ### Create your Infrastructure as Code base repository
 
@@ -57,10 +58,11 @@ Now the environment should be generated at `config/environments/*env_name*`
 
 ### Add a module to your environment
 
-To add a Kite module to your environment, you should first initialize it:
+To add a Kite module to your environment, you should first initialize it.
+It's recommended to use specific module versions/tags(master branch would be used by default):
 
 ```
-  kite module init https://url.for/your/module --env *env_name*
+  kite module init https://url.for/your/module --env *env_name* --version *x.y.z/x-y-stable*
 ```
 
 This should clone module's source files into `modules/*module_name*` and create a `vars.*module_name*.yml` file with all variables needed by the module.
@@ -80,6 +82,7 @@ Set your default gcloud credentials using
 ```
 
 ```
+  kite terraform init
   kite terraform apply --env *env_name*
 ```
 
@@ -107,4 +110,4 @@ $ ruby -Ilib ./bin/concourse/in
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/helios-technologies/kite.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubykube/kite.

data/ci/bump.rb

@@ -0,0 +1,207 @@
+require "rubygems/version"
+require "net/http"
+require "json"
+require "uri"
+
+#
+# Returns bot's username in GitHub.
+#
+# @return [String]
+def bot_username
+  ENV.fetch("BOT_USERNAME", "kite-bot")
+end
+
+#
+# Returns bot's displayed name in commits.
+#
+# @return [String]
+def bot_name
+  ENV.fetch("BOT_NAME", "Kite Bot")
+end
+
+#
+# Returns bot's displayed email in commits.
+#
+# @return [String]
+def bot_email
+  ENV.fetch("BOT_EMAIL", "kite-bot@heliostech.fr")
+end
+
+#
+# Returns GitHub repository slug in form of :user|:organization/:repository.
+#
+# @return [String]
+def repository_slug
+  ENV.fetch("REPOSITORY_SLUG", "rubykube/kite")
+end
+
+#
+# Increments the newest available version which is in stage of development (master),
+# and publishes it on the GitHub.
+#
+# The requirements for this to work are:
+#  1) Repository has some tagged versions.
+#  2) The latest version is not released yet (e.g. there is no version-specific branch like "1-3-stable").
+#
+# If you are on 1.1 and you want to start developing 1.2 do the following:
+#  1) Create branch "1-1-stable", and push up-to-date source to it.
+#  2) Push the same to master branch.
+#  3) Push new commit(s) to master, and tag master as 1.2.0.
+#  4) Future pushes to master will be treated as new patch version number.
+#
+def bump_from_master_branch
+  # Get latest version of Kite.
+  return unless (latest_version = versions.last)
+
+  # Find a branch which is specific the version.
+  # Comparision is based only on major and minor version numbers since
+  # these type of branches are named with a convention like: "1-0-stable", "2-4-stable", and so on.
+  linked_branch = version_specific_branches.find { |b| b[:version].segments == latest_version.segments[0...2] }
+  # If branch exists it means that version has been already released.
+  return if linked_branch
+
+  # Increment patch version number, tag, and push.
+  candidate_version = Gem::Version.new(latest_version.segments.dup.tap { |s| s[2] += 1 }.join("."))
+  tag_n_push(candidate_version.to_s, name: 'master') unless versions.include?(candidate_version)
+end
+
+#
+# Increments the version which is in stage of support (version-specific branches only),
+# and publishes it on the GitHub.
+#
+# The method expects branch name in form of "X-Y-stable", like "2-0-stable".
+# It tags the current Git commit to the next patch number version, and pushes it to Git repository.
+#
+# @param name [String]
+#   Branch name.
+
+def bump_from_version_specific_branch(name)
+  # This helps to ensure branch does exist.
+  branch = version_specific_branches.find { |b| b[:name] == name }
+  return unless branch
+
+  # Find latest version for the branch (compare by major and minor).
+  # We use find here since versions are sorted in descending order.
+  latest_version = versions.reverse.find { |v| v.segments[0...2] == branch[:version].segments }
+  return unless latest_version
+
+  # Increment patch version number, tag, and push.
+  candidate_version = Gem::Version.new(latest_version.segments.dup.tap { |s| s[2] += 1 }.join("."))
+  tag_n_push(candidate_version.to_s, branch) unless versions.include?(candidate_version)
+end
+
+#
+# Configures Git user name & email,
+# updates version at lib/kite/version.rb,
+# creates Git tag, and pushes all the changes made to repository.
+#
+# @param tag [String]
+def tag_n_push(tag, branch)
+  File.open "lib/kite/version.rb", "w" do |f|
+    f.write <<-RUBY
+module Kite
+  VERSION = '#{tag}'
+end
+    RUBY
+  end
+
+  [
+    %( git config --global user.email "#{bot_email}" ),
+    %( git config --global user.name "#{bot_name}" ),
+    %( git remote add authenticated-origin https://#{bot_username}:#{ENV.fetch("GITHUB_API_KEY")}@github.com/#{repository_slug} ),
+    %( git checkout -b release ),
+    %( git add lib/kite/version.rb ),
+    %( git commit -m "[ci skip] Bump #{tag}." ),
+    %( git push authenticated-origin release:#{branch.fetch(:name)} ),
+    %( git tag v#{tag} -a -m "Automatically generated tag from TravisCI build #{ENV.fetch("TRAVIS_BUILD_NUMBER")}." ),
+    %( git push authenticated-origin v#{tag} )
+  ].each do |command|
+    command.strip!
+    unless Kernel.system(command)
+      # Prevent GitHub API key from being published.
+      command.gsub!(ENV["GITHUB_API_KEY"], "(secret)")
+      raise %(Command "#{command}" exited with status #{$?.exitstatus || "(unavailable)"}.)
+    end
+  end
+end
+
+#
+# Loads all Kite tags, and returns them in ascending order.
+#
+# @return [Array<Gem::Version>]
+def versions
+  @versions ||= github_api_authenticated_get("/repos/#{repository_slug}/tags").map do |x|
+    Gem::Version.new(x.fetch("name")[/\d+\.\d+\.\d+/])
+  end.sort
+end
+
+#
+# Returns hash with all tagged commits as keys (SHA-1) and versions as values.
+#
+# @return [Hash]
+#   Key is commit's SHA-1 hash, value is instance of Gem::Version.
+def tagged_commits_mapping
+  @commits ||= github_api_authenticated_get("/repos/#{repository_slug}/tags").each_with_object({}) do |x, memo|
+    memo[x.fetch("commit").fetch("sha")] = Gem::Version.new(x.fetch("name")[/\d+\.\d+\.\d+/])
+  end
+end
+
+#
+# Loads all Kite branches, selects only version-specific, and returns them.
+#
+# @return [Array<Hash>]
+#   Array of hashes each containing "name" & "version" keys.
+def version_specific_branches
+  @branches ||= github_api_authenticated_get("/repos/#{repository_slug}/branches").map do |x|
+    if x.fetch("name") =~ /\A(\d)-(\d)-\w+\z/
+      { name: x["name"], version: Gem::Version.new($1 + "." + $2) }
+    end
+  end.compact
+end
+
+#
+# Performs call to GitHub API and returns the response. Raises in case of non-200 status.
+#
+# @param path [String]
+#   Request path.
+# @return [Hash]
+def github_api_authenticated_get(path)
+  http         = Net::HTTP.new("api.github.com", 443)
+  http.use_ssl = true
+  response     = http.get path, "Authorization" => %[token #{ENV.fetch("GITHUB_API_KEY")}]
+  if response.code.to_i == 200
+    JSON.load(response.body)
+  else
+    raise StandardError, %[HTTP #{response.code}: "#{response.body}".]
+  end
+end
+
+#
+# Returns true if version has exactly 3 version segments (major, minor, patch), and all are integers.
+#
+# @param version [Gem::Version]
+# @return [true, false]
+def generic_semver?(version)
+  version.segments.count == 3 && version.segments.all? { |segment| segment.match?(/\A[0-9]+\z/) }
+end
+
+# Build must not run on a fork.
+bump   = ENV["TRAVIS_REPO_SLUG"] == repository_slug
+# Skip PRs.
+bump &&= ENV["TRAVIS_PULL_REQUEST"] == "false"
+# Build must run on branch.
+bump &&= !ENV["TRAVIS_BRANCH"].to_s.empty?
+# GitHub API key must be available.
+bump &&= !ENV["GITHUB_API_KEY"].to_s.empty?
+# Build must not run on tag.
+bump &&= ENV["TRAVIS_TAG"].to_s.empty?
+# Ensure this commit is not tagged.
+bump &&= !tagged_commits_mapping.key?(ENV["TRAVIS_COMMIT"])
+
+if bump
+  if ENV["TRAVIS_BRANCH"] == "master"
+    bump_from_master_branch
+  else
+    bump_from_version_specific_branch(ENV["TRAVIS_BRANCH"])
+  end
+end

data/kite.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "git"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "git"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "codecov"

data/lib/kite/module.rb

@@ -2,19 +2,25 @@ module Kite
   class Module < Base
     include Kite::Helpers
 
-    method_option :env, type: :string, desc: "Environment", required: true, default: ENV['KITE_ENV']
+    method_option :env,     type: :string, desc: "Environment", required: true, default: ENV['KITE_ENV']
+    method_option :version, type: :string, desc: "Version", required: false
     desc 'init https://github.com/foo/bar-module', 'Initialize a kite module and render its vars.module.yml'
     def init(path)
-      @env  = options[:env]
-      @path = path
-      @name = path.gsub(/(.*:|.git)/, '').split('/').last
+      @env     = options[:env]
+      @path    = path
+      @name    = path.gsub(/(.*:|.git)/, '').split('/').last
+      @cloud   = parse_cloud_config[@env]
+      @version = options[:version]
 
       unless File.exist? path
         @uri  = path
         @path = "modules/#{@name}"
 
-        say "Cloning the module"
         clone_module
+        unless @version.nil?
+          checkout_version
+        end
+
         say "Use git submodule add #{@path} to be able to commit this module as a submodule", :yellow
       end
 
@@ -42,6 +48,8 @@ module Kite
       end
 
       def clone_module
+        say "Cloning the module"
+
         if File.exist? @path
           overwrite = ask "#{@path} already contains a module! Overwrite? (y/N)"
 
@@ -50,13 +58,26 @@ module Kite
             Git.clone(@uri, @path)
             say "Successfully cloned the fresh #{@name}!", :green
           else
-            say "Keeping the current module version"
+            say "Keeping the current module revision"
           end
         else
           Git.clone(@uri, @path)
         end
       end
 
+      def checkout_version
+        module_git = Git.open(@path)
+
+        say "Switching to #{@version}"
+        if @version =~ /\d+\.\d+\.\d+/ && module_git.tags.any? { |t| t.name == @version }
+          module_git.checkout("tags/#{@version}")
+        elsif module_git.is_remote_branch? @version
+          module_git.checkout("origin/#{@version}")
+        else
+          say "#{@version} tag/branch was not found in the module, keeping the current one", :red
+        end
+      end
+
       def render_vars
         create_file "config/environments/#{@env}/vars.#{@name}.yml", YAML.dump(manifest['variables'])
       end
@@ -71,7 +92,7 @@ module Kite
       end
 
       def manifest
-        YAML.load(File.open("#{@path}/manifest.yml"))
+        YAML.load(ERB.new(File.read("#{@path}/manifest.yml.tt")).result(binding))
       end
     end
 

data/lib/kite/version.rb

@@ -1,3 +1,3 @@
 module Kite
-  VERSION = "1.0.2"
+  VERSION = '1.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kite
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Louis Bellet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
@@ -146,6 +147,7 @@ files:
 - bin/kite
 - bin/kite-config
 - bin/kite-console
+- ci/bump.rb
 - config/pipelines/review.yml
 - config/pipelines/tasks/create-pull-requests-tag.yml
 - config/pipelines/tasks/create-repository-tag.yml
@@ -213,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Command line tool for devops scaffolding.