kurgan 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3fe34e72bd7fc90667d4fbcc0c1981f284a1a7670c6735ccf276cf5f6b7a79d
-  data.tar.gz: 8b6cfeb1b0cce8e69e0f387c6ebc346f4ba2c5ec36fef0a4ac4ab651280a49dd
+  metadata.gz: 2ed9790e405062d96996a8ee171a7d3ac0cfdaf675b458f3cb38015e936c01b3
+  data.tar.gz: '09e6b0290f9ad301146292353f5235dafd1023f2198ea5d160a1ddba3ca74b11'
 SHA512:
-  metadata.gz: 6a3efca63e094ee686b5d9a65489eaf7b700ac4e0191b863ff7e9f070111d8906a0f9e6b2f7fd03be55c6b429e7bed254da0b110d654115e4a53a02a2e9e1957
-  data.tar.gz: e6dc44b198c12ba1cdd4012f8cde7c1d6c0395e81de561ff63ab418e96e99541dcbcad94c3c0813f084e157fbff211eda690f15eabb699508ff95e0f673b248f
+  metadata.gz: 9b7bdf67f194e510c687775b3c1a89b5b24aee7aca3fc93b2ecd61ae05efe19861b60935d6c8e99666f6b18ad4f922556bee3f7a27c9020f2df7c05801c044d2
+  data.tar.gz: 9aaceb7c925e2e7cfbfb389b157348d4b4d6aff625962415430547d709e3699d0b6b7a5f1d421d6c7ae4e5c62f4ef74e824d4c0440393fa0bd8bf0e752bd1d48

data/.github/workflows/build-gem.yml

@@ -0,0 +1,25 @@
+name: test and build gem
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: test + build
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: set up ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    - name: rspec
+      run: |
+        gem install rspec
+        rspec
+    - name: build gem
+      run: |
+        gem build kurgan.gemspec

data/.github/workflows/release-gem.yml

@@ -0,0 +1,24 @@
+name: release gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build and publish gem
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repo
+      uses: actions/checkout@v2
+    
+    - name: Set up ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    
+    - name: Publish gem
+      uses: dawidd6/action-publish-gem@v1
+      with:
+        api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    kurgan (0.1.3)
+    kurgan (0.2.2)
       thor (~> 0.19)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.5.0)
+    rake (13.0.1)
     thor (0.20.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0)
   kurgan!
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   1.16.1
+   2.0.1

data/README.md

@@ -1,7 +1,7 @@
 # Kurgan
 ---
 
-[![Build Status](https://travis-ci.org/theonestack/kurgan.svg?branch=develop)](https://travis-ci.org/theonestack/kurgan) [![Join the chat at https://gitter.im/theonestack/cfhighlander](https://badges.gitter.im/theonestack/cfhighlander.svg)](https://gitter.im/theonestack/cfhighlander?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.com/theonestack/kurgan.svg?branch=master)](https://travis-ci.com/theonestack/kurgan) [![Join the chat at https://gitter.im/theonestack/cfhighlander](https://badges.gitter.im/theonestack/cfhighlander.svg)](https://gitter.im/theonestack/cfhighlander?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Tool to manage CfHighlander stacks
 

data/kurgan.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "http://mygemserver.com"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 0.19"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

data/lib/kurgan.rb

@@ -5,6 +5,7 @@ require 'kurgan/globals'
 require "kurgan/init"
 require "kurgan/component"
 require "kurgan/add"
+require "kurgan/test"
 require "kurgan/list"
 
 module Kurgan
@@ -25,6 +26,9 @@ module Kurgan
     register Kurgan::Add, 'add', 'add [component]', 'Adds a new component to an existing CfHighlander project'
     tasks["add"].options = Kurgan::Add.class_options
 
+    register Kurgan::Test, 'test', 'test [name]', 'Create a new test case for a component'
+    tasks["test"].options = Kurgan::Test.class_options
+
     desc "list", "List available components and latest version from theonestack github"
     method_option :filter, aliases: '-f', type: :string, desc: "filter components by service type"
     method_option :component, aliases: '-c', type: :string, desc: "list all versions for matched components"

data/lib/kurgan/add.rb

@@ -2,7 +2,7 @@ module Kurgan
   class Add < Thor::Group
     include Thor::Actions
 
-    argument :template
+    argument :component
 
     class_option :name, aliases: :n, type: :string
     class_option :version, aliases: :v, type: :string
@@ -15,11 +15,11 @@ module Kurgan
     end
 
     def get_component_name
-      @name = options[:name] || template
+      @name = options[:name] || component
     end
 
     def get_template_version
-      @template = options[:version] ? "#{template}@#{options[:version]}" : template
+      @template = options[:version] ? "#{component}@#{options[:version]}" : component
       say "adding #{@template} to the #{@cfhighlander_template.split('.')[0]} project"
     end
 

data/lib/kurgan/component.rb

@@ -3,6 +3,10 @@ require 'kurgan/init'
 module Kurgan
   class Component < Kurgan::Init
 
+    def set_type
+      @type = 'component'
+    end
+
     def set_directory
       @dir = ask "directory name ", default: "hl-component-#{name}"
       empty_directory @dir
@@ -23,6 +27,11 @@ module Kurgan
       template('templates/cfndsl.rb.tt', "#{@dir}/#{name}.cfndsl.rb")
     end
 
+    def create_default_config_test
+      @test_name = 'default'
+      template('templates/test.yaml.tt', "#{@dir}/tests/#{@test_name}.test.yaml")
+    end
+
     def copy_licence
       if yes?("Use MIT license?")
         copy_file "templates/MITLICENSE", "#{@dir}/LICENSE"
@@ -31,13 +40,5 @@ module Kurgan
       end
     end
 
-    def create_travis_config
-      if yes?("Use Travis-ci?")
-        copy_file "templates/travis.yml.tt", "#{@dir}/travis-ci.yml"
-      else
-        say "skipping travis", :yellow
-      end
-    end
-
   end
 end

data/lib/kurgan/init.rb

@@ -7,12 +7,16 @@ module Kurgan
 
     argument :name
 
-    class_option :type, aliases: :t, default: 'empty', enum: ['empty','vpc','ecs'], desc: "Create a pre-canned project"
+    class_option :project, aliases: '-p', default: 'empty', enum: ['empty','vpc','ecs'], desc: "Create a pre-canned project"
 
     def self.source_root
       File.dirname(__FILE__)
     end
 
+    def set_type
+      @type = 'project'
+    end
+
     def set_directory
       @dir = ask "directory name ", default: name
       empty_directory @dir
@@ -23,11 +27,11 @@ module Kurgan
     end
 
     def set_template_parameters
-      @parameters = Kurgan::Projects.properties[options['type'].to_sym][:parameters]
+      @parameters = Kurgan::Projects.properties[options['project'].to_sym][:parameters]
     end
 
     def set_template_components
-      @components = Kurgan::Projects.properties[options['type'].to_sym][:components]
+      @components = Kurgan::Projects.properties[options['project'].to_sym][:components]
     end
 
     def create_cfhighlander_template
@@ -43,7 +47,7 @@ module Kurgan
       if yes?("git init project?")
         run "git init #{@dir}"
         template 'templates/gitignore.tt', "#{@dir}/.gitignore"
-        template 'templates/README.md.tt', "#{@dir}/README.md"
+        template "templates/README.md.tt", "#{@dir}/README.md"
       else
         say "Skipping git init", :yellow
       end
@@ -51,11 +55,13 @@ module Kurgan
 
     def ci_init
       if yes?("Setup a CI pipeline?")
-        type = ask "CI flavour", limited_to: ['jenkins', 'travis', 'codebuild']
-        case type
+        ci = ask "CI flavour", limited_to: ['github', 'jenkins', 'travis', 'codebuild']
+        case ci
+        when 'github'
+          template('templates/github_actions.yaml.tt', "#{@dir}/.github/workflows/rspec.yaml")
         when 'jenkins'
           template('templates/Jenkinsfile.tt', "#{@dir}/Jenkinsfile")
-        when 'travis-ci'
+        when 'travis'
           template('templates/travis.yml.tt', "#{@dir}/.travis.yml")
         when 'codebuild'
           template('templates/codebuild.yaml.tt', "#{@dir}/.codebuild.yaml")

data/lib/kurgan/list.rb

@@ -1,4 +1,5 @@
 require 'open-uri'
+require 'fileutils'
 
 module Kurgan
   class List

data/lib/kurgan/templates/Jenkinsfile.tt

@@ -3,16 +3,42 @@ pipeline {
   environment {
     AWS_REGION = 'us-east-1'
     PROJECT_NAME = '<%= @name %>'
+    VERSION = '0.1.0'
   }
 
   agent {
     docker {
-        image 'theonestack/cfhighlander'
+      image 'theonestack/cfhighlander'
     }
   }
 
   stages {
 
+<%- if @type == 'component' -%>
+    stage('cftest') {
+      steps {
+        sh 'cfndsl -u'
+        sh "cfhighlander cftest -r xml"
+      }
+      post {
+        always {
+          junit 'reports/report.xml'
+        }
+      }
+    }
+
+    stage('cfn nag') {
+      agent {
+        docker {
+          image 'base2/cfn-nag'
+          reuseNode true
+        }
+      }
+      steps {
+        sh 'cfn_nag_scan -i out/tests'
+      }
+    }
+<%- elsif @type == 'project' -%>
     stage('Compile and validate templates') {
       steps {
         sh 'cfndsl -u'
@@ -20,20 +46,24 @@ pipeline {
       }
     }
 
-    stage('Publish templates to S3') {
-      steps {
-        script {
-          env['VERSION'] = ${env.BRANCH_NAME}-${env.SHORT_COMMIT}
+    stage('cfn nag') {
+      agent {
+        docker {
+          image 'base2/cfn-nag'
+          reuseNode true
         }
-        sh "cfpublish ${PROJECT_NAME} --version ${VERSION}"
+      }
+      steps {
+        sh 'cfn_nag_scan -i out/yaml'
       }
     }
 
-    stage('Deploy') {
+    stage('Publish templates') {
       steps {
-        println "Deploying ${env.PROJECT_NAME} version ${env.VERSION}"
+        sh "cfpublish ${env.PROJECT_NAME} --version ${env.VERSION}"
       }
     }
+<%- end -%>
 
   }
 }

data/lib/kurgan/templates/README.md.tt

@@ -1,5 +1,4 @@
-# <%= name %> CfHighlander project
----
+# <%= name %> CfHighlander <%= @type %>
 
 ## Cfhighlander Setup
 
@@ -14,14 +13,18 @@ or via docker
 ```bash
 docker pull theonestack/cfhighlander
 ```
+<%- if @type == 'component' -%>
+## Testing Components
 
-compiling the templates
+Running the tests
 
 ```bash
-cfcompile <%= name %>
+cfhighlander cftest <%= name %>
 ```
+<%- elsif @type == 'project' -%>
+## Compiling the project
 
-compiling with the vaildate fag to validate the templates
+compiling with the validate tag to validate the templates
 
 ```bash
 cfcompile <%= name %> --validate
@@ -32,3 +35,4 @@ publish the templates to s3
 ```bash
 cfpublish <%= name %> --version latest
 ```
+<%- end -%>

data/lib/kurgan/templates/cfndsl.rb.tt

@@ -1,3 +1,6 @@
 CloudFormation do
   ## Add your cfndsl resources here
+  SNS_Topic(:Topic) {
+    TopicName topic_name if defined? topic_name
+  }
 end

data/lib/kurgan/templates/codebuild.yaml.tt

@@ -7,7 +7,13 @@ env:
 phases:
   install:
     commands:
-      - gem install cfhighlander
+      - gem install cfhighlander cfn-nag
   build:
     commands:
+<%- if @type == 'component' -%>
+      - cfhighlander cftest
+      - cfn_nag_scan -i out/tests
+<%- elsif @type == 'project' -%>
       - cfcompile --validate
+      - cfn_nag_scan -i out/yaml
+<%- end -%>

data/lib/kurgan/templates/github_actions.yaml.tt

@@ -0,0 +1,25 @@
+name: cftest
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: set up ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    - name: install gems
+      run: gem install cfhighlander rspec 
+    - name: set cfndsl spec
+      run: cfndsl -u
+    - name: cftest
+      run: rspec
+      env:
+        AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_REGION: ap-southeast-2

data/lib/kurgan/templates/gitignore.tt

@@ -1 +1,2 @@
 out/
+reports/

data/lib/kurgan/templates/test.spec.tt

@@ -0,0 +1,31 @@
+require 'yaml'
+
+describe 'compiled component <%= @component_name %>' do
+  
+  context 'cftest' do
+    it 'compiles test' do
+      expect(system("cfhighlander cftest #{@validate} --tests tests/<%= @test_name %>.test.yaml")).to be_truthy
+    end      
+  end
+  
+  let(:template) { YAML.load_file("#{File.dirname(__FILE__)}/../out/tests/<%= @test_name %>/<%= @component_name %>.compiled.yaml") }
+  
+  context "Resource" do
+
+    <% config['Resources'].each do |resource, details| %>
+    context "<%= resource %>" do
+      let(:resource) { template["Resources"]["<%= resource %>"] }
+
+      it "is of type <%= details['Type'] %>" do
+          expect(resource["Type"]).to eq("<%= details['Type'] %>")
+      end
+      <% if details.has_key?('Properties')%><% details['Properties'].each do |property, value| %>
+      it "to have property <%= property %>" do
+          expect(resource["Properties"]["<%= property %>"]).to eq(<%= value.is_a?(String) ? "\"#{value}\"" : value %>)
+      end
+      <% end %><% end %>
+    end
+    <% end %>
+  end
+
+end

data/lib/kurgan/templates/test.yaml.tt

@@ -0,0 +1,6 @@
+test_metadata:
+  type: config
+  name: <%= @test_name %>
+  description: set the description for your test
+
+# Insert your tests here

data/lib/kurgan/templates/travis.yml.tt

@@ -1,6 +1,15 @@
 language: ruby
 rvm:
   - 2.5
+install:
+  - gem install cfhighlander cfn-nag
+before_script:
+  - cfndsl -u
+<%- if @type == 'component' -%>
 script:
-  - gem install cfhighlander
-  - if [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then cfcompile ; else cfcompile --validate; fi%
+  - if [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then cfhighlander cftest --no-validate; else cfhighlander cftest; fi
+  - cfn_nag_scan -i out/tests
+<%- elsif @type == 'project' -%>
+script:
+  - cfcompile
+<%- end -%>

data/lib/kurgan/test.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+
+module Kurgan
+  class Test < Thor::Group
+    include Thor::Actions
+
+    argument :test_name
+
+    class_option :type, aliases: :t, type: :string, enum: %w(config spec), default: 'config'
+    class_option :directory, aliases: :d, type: :string, default: 'tests'
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def get_cfhighlander_template
+      @cfhighlander_template = Dir['*.cfhighlander.rb'][0]
+      if @cfhighlander_template.nil?
+        raise "No cfhighlander.rb file found in #{Dir.pwd}"
+      end
+      @component_name = @cfhighlander_template.split('.').first
+    end
+
+    def create_test
+      case options[:type]
+      when 'config'
+        template('templates/test.yaml.tt', "#{options[:directory]}/#{test_name}.test.yaml")
+        say "created config test case #{options[:directory]}/#{test_name}.test.yaml", :green
+      when 'spec'
+        output_file = "#{Dir.pwd}/out/tests/#{test_name}/#{@component_name}.compiled.yaml"
+        if !File.file?(output_file)
+          error "compile cloudformation test output file #{output_file} not found.\nRun `cfhighlander cftest -t #{options[:directory]}/#{test_name}.test.yaml`"
+        end
+        compiled_test = YAML.load_file("#{Dir.pwd}/out/tests/#{test_name}/#{@component_name}.compiled.yaml")
+        template('templates/test.spec.tt', "spec/#{test_name}_spec.rb", compiled_test)
+        say "created spec test spec/#{test_name}_spec.rb", :green
+      else
+        error "#{options[:type]} is not a supported test type yet", :red
+      end
+    end
+
+  end
+end

data/lib/kurgan/version.rb

@@ -1,3 +1,3 @@
 module Kurgan
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kurgan
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: Manage a cfhighalnder project
 email:
 - theonestackcfhighlander@gmail.com
@@ -60,8 +60,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-gem.yml"
+- ".github/workflows/release-gem.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -83,14 +84,18 @@ files:
 - lib/kurgan/templates/cfndsl.rb.tt
 - lib/kurgan/templates/codebuild.yaml.tt
 - lib/kurgan/templates/config.yaml.tt
+- lib/kurgan/templates/github_actions.yaml.tt
 - lib/kurgan/templates/gitignore.tt
+- lib/kurgan/templates/test.spec.tt
+- lib/kurgan/templates/test.yaml.tt
 - lib/kurgan/templates/travis.yml.tt
+- lib/kurgan/test.rb
 - lib/kurgan/version.rb
 homepage: http://iamkurgan.com
 licenses:
 - MIT
 metadata:
-  allowed_push_host: http://mygemserver.com
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Manage a cfhighalnder project

data/.travis.yml

@@ -1,17 +0,0 @@
-sudo: required
-dist: trusty
-language: ruby
-rvm:
-  - 2.5
-script:
-  - bundle install
-  - gem build kurgan.gemspec
-  - gem install kurgan-*.gem
-  - kurgan help
-deploy:
-  provider: rubygems
-  api_key: "${RUBYGEMS_API_KEY}"
-  gem: kurgan
-  on:
-   all_branches: true
-   condition: $TRAVIS_BRANCH =~ ^develop|master &&  $TRAVIS_EVENT_TYPE =~ ^push|api$ && $TRAVIS_REPO_SLUG == "theonestack/kurgan"