kurgan 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85a9e2245bfe3886184f93bae66f16c5f8b565354ada5319f9ce5e0c40fd9775
-  data.tar.gz: 5e8ae3b2bd577f44ee6c0f11999a67dbb3674a3f07c4d52c7f88a1f50bd08fae
+  metadata.gz: 488e05edbe120ded7cbfb9dbaa7b751fc4cc168192d4ac63e31d107481073587
+  data.tar.gz: c57b6526b9b8e69b73c7089619337d6e2cc4575d9f72a8a65a36850b02b32881
 SHA512:
-  metadata.gz: c610c92985b8211e380fcd6597ed24a151af72eda13142812618ac37db87d7c9328757b2d94e3fb3ff3c0c5710af129226eaa827d062ea1551c3a23acacc6917
-  data.tar.gz: ff7b9e28fa2496a129f1dbbcff7157b52ce394dcadad23fd1992c3702c6c8e7ae2e4f3aa343d41260d575492c80760ded2c1c665aa9e3d8fe7019014e366a9d0
+  metadata.gz: df9a706171fd7bd1d722cb43f9e8bac729514fb2fec973d47a03d342e453e39817f31aa9271029dca782948f4f6129e9f4c9a38b4c3e31ab149a31d44cccf1b3
+  data.tar.gz: 05d00def80a4cd83c51feab7b94602b27e29cb2c4de1526577d5016391ae2afd2fe465d63c02f56d034a124072caaec3a8dc9da89f18b0a5cac3c07f4492ee94

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,14 +1,34 @@
 PATH
   remote: .
   specs:
-    kurgan (0.2.0)
+    kurgan (0.3.0)
+      faraday (~> 1, < 2)
+      terminal-table (~> 1, < 2)
       thor (~> 0.19)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.5.0)
+    faraday (1.4.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    multipart-post (2.1.1)
+    rake (13.0.1)
+    ruby2_keywords (0.0.5)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.20.3)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -16,7 +36,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   kurgan!
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,20 +1,244 @@
 # Kurgan
 ---
+![build workflow](https://github.com/theonestack/kurgan/actions/workflows/build-gem.yml/badge.svg)
+![release workflow](https://github.com/theonestack/kurgan/actions/workflows/release-gem.yml/badge.svg)
 
-[![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)
+Command line tool to create and manage CfHighlander projects and components
 
-Tool to manage CfHighlander stacks
+## Setup
+
+```sh
+gem install kurgan
+```
+
+## Usage
+
+### Help
+
+view all available commands
 
 ```bash
+➜  kurgan help
 Commands:
-  kurgan --version, -v     # print the version
-  kurgan add [component]   # Adds a new component to an existing CfHighlander project
-  kurgan component [name]  # Generates a new CfHighlander component
-  kurgan help [COMMAND]    # Describe available commands or one specific command
-  kurgan list              # List available components and latest version from theonestack github
-  kurgan project [name]    # Generates a new CfHighlander project
+  kurgan --version, -v       # print the version
+  kurgan add [component]     # Adds a new component to an existing CfHighlander project
+  kurgan component [name]    # Generates a new CfHighlander component
+  kurgan extend [component]  # Generates a files to extend a component in a CfHighlander project
+  kurgan help [COMMAND]      # Describe available commands or one specific command
+  kurgan inspect             # inspect a cfhighlander files of it's components
+  kurgan list                # list all components in the onestack
+  kurgan project [name]      # Generates a new CfHighlander project
+  kurgan search [component]  # search for a component and it's release history
+  kurgan test [name]         # Create a new test case for a component
+```
+
+help can also be used on commands to see available options and usage
+
+```bash
+➜  kurgan help project
+Usage:
+  kurgan project [name]
+
+Options:
+  -p, [--project=PROJECT]  # Create a pre-canned project
+                           # Default: empty
+                           # Possible values: empty, vpc, ecs
+
+Generates a new CfHighlander project
+```
+
+### Create a New Project
+
+A CfHighlander project allows you to configure and compile a group of components to generate you Cloudformation stack.
+
+To create a new project run the `project` command with the name of your new project and fill in the prompts
+
+```sh
+➜  kurgan project myproject
+directory name  (myproject)
+      create  myproject
+template description  (myproject)
+      create  myproject/myproject.cfhighlander.rb
+      create  myproject/myproject.config.yaml
+git init project? y
+         run  git init myproject from "."
+Initialized empty Git repository in /Users/gus/src/testbed/hl/myproject/.git/
+      create  myproject/.gitignore
+      create  myproject/README.md
+Setup a CI pipeline? y
+CI flavour [github, jenkins, travis, codebuild] jenkins
+      create  myproject/Jenkinsfile
+```
+
+cd into the new directory and you'll see the following project structure
+
+```txt
+.
+├── Jenkinsfile # depending on CI flavour this will be different
+├── README.md
+├── myproject.cfhighlander.rb
+└── myproject.config.yaml
+```
+
+
+### Add a Component to a Project
+
+To add a component to your nproject use the `add` command along with the component name with optional component version and friendly name
+
+```sh
+➜  myproject git:(master) ✗ kurgan add vpc-v2 --name network --version 0.7.0
+adding vpc-v2@0.7.0 to the myproject project
+      insert  myproject.cfhighlander.rb
+      create  network.config.yaml
+```
+
+this will create a yaml config file for the new component configuration and add the component to the `myproject.cfhighlander.rb` file
+
+```rb
+CfhighlanderTemplate do
+  Name 'myproject'
+  Description "myproject"
+  Component name: 'network', template: 'vpc-v2@0.7.0'
+end
+```
+
+
+### Extend a Component in a Project
+
+Extending a component allows you to add resources to an existing component whilest still allowing you to update the component.
+
+to extend a component use the `extend` command along with the component name with optional component version and friendly name
+
+```sh
+➜  myproject git:(master) ✗ kurgan extend aurora-mysql --name database --version 3.3.0
+      create  database
+extending aurora-mysql@3.3.0 to the myproject project
+      create  database/database.cfhighlander.rb
+      create  database/database.config.yaml
+      create  database/database.cfndsl.rb
+      insert  myproject.cfhighlander.rb
+```
+
+this will create a new sub directory with a cfhighlander file containing the component you're extending, a cfndsl file to add your resources and a config.yaml for configuration
+
+```txt
+.
+├── Jenkinsfile
+├── README.md
+├── database
+│   ├── database.cfhighlander.rb
+│   ├── database.cfndsl.rb
+│   └── database.config.yaml
+├── myproject.cfhighlander.rb
+├── myproject.config.yaml
+└── network.config.yaml
 ```
 
+```rb
+CfhighlanderTemplate do
+  Name 'database'
+  Extends 'aurora-mysql@3.3.0'
+end
+```
+
+
+### Inspect a Project
+
+To see a list of components used by a project including versions and latest available version use the `inspect` command.
+
+```sh
+➜  myproject git:(master) ✗ kurgan inspect
++-----------+-----------+----------------+
+|           Project: myproject           |
++-----------+-----------+----------------+
+| Component | Version   | Latest Release |
++-----------+-----------+----------------+
+| vpc-v2    | 0.7.0     | 0.7.0          |
++-----------+-----------+----------------+
+```
+
+
+### Create a New Component
+
+Components are the basic building blocks of CfHighlander, containing cloudformation resources that can be templated and reused across multiple project.
+
+To create a new project use the `component` command with the name of your new component and fill in the prompts
+
+```txt
+➜  kurgan component rds-mysql
+directory name  (hl-component-rds-mysql)
+      create  hl-component-rds-mysql
+template description  (rds-mysql - #{component_version})
+      create  hl-component-rds-mysql/rds-mysql.cfhighlander.rb
+      create  hl-component-rds-mysql/rds-mysql.config.yaml
+git init project? y
+         run  git init hl-component-rds-mysql from "."
+Initialized empty Git repository in /Users/gus/src/testbed/hl/hl-component-rds-mysql/.git/
+      create  hl-component-rds-mysql/.gitignore
+      create  hl-component-rds-mysql/README.md
+Setup a CI pipeline? y
+CI flavour [github, jenkins, travis, codebuild] github
+      create  hl-component-rds-mysql/.github/workflows/spec.yaml
+      create  hl-component-rds-mysql/rds-mysql.cfndsl.rb
+      create  hl-component-rds-mysql/tests/default.test.yaml
+Use MIT license? y
+      create  hl-component-rds-mysql/LICENSE
+```
+
+the following folder structure is generated
+
+```txt
+.
+├── LICENSE
+├── README.md
+├── rds-mysql.cfhighlander.rb
+├── rds-mysql.cfndsl.rb
+├── rds-mysql.config.yaml
+└── tests
+    └── default.test.yaml
+```
+
+
+### Add tests to a Component
+
+Kurgan can be used to add configuration tests to a component as well as generating spec tests based upon the cloudformation generated by a configuration test.
+
+to create a new config test run the test command along with the name of the test
+
+```sh
+➜  hl-component-rds-mysql git:(master) ✗ kurgan test mytest
+      create  tests/mytest.test.yaml
+created config test case tests/mytest.test.yaml
+```
+
+A test.yaml file is created in the tests directory, add in you test and run the `cfhighlander test` command to execute the test
+
+Once the cftest has successfully passed you can then generate a spec test from the cloudformation template generated by the test in the `out/tests/<test-name>/` directory
+
+To generate the spec test use the `test` command again with the name of the test and pass the `--type spec` flag
+
+```sh
+➜  hl-component-rds-mysql git:(master) ✗ kurgan test mytest --type spec
+      create  spec/mytest_spec.rb
+created spec test spec/mytest_spec.rb
+```
+
+
+### Searching for Components
+
+to list all available components on the onestack use the `list` command
+
+```sh
+➜  kurgan list
+```
+
+to search for a components releases use the `search [component]` command
+
+```sh
+➜  kurgan search vpc
+```
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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."
@@ -31,7 +31,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "terminal-table", '~> 1', '<2'
+  spec.add_dependency "faraday", '~> 1', '<2'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

data/lib/kurgan.rb

@@ -7,6 +7,9 @@ require "kurgan/component"
 require "kurgan/add"
 require "kurgan/test"
 require "kurgan/list"
+require "kurgan/extend"
+require "kurgan/search"
+require "kurgan/inspect"
 
 module Kurgan
   class Cli < Thor
@@ -26,18 +29,20 @@ 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::Extend, 'extend', 'extend [component]', 'Generates a files to extend a component in a CfHighlander project'
+    tasks["extend"].options = Kurgan::Extend.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"
-    method_option :update, aliases: '-u', type: :boolean, lazy_default: true, default: false, desc: "Update components list"
-    def list
-      cmd = Kurgan::List.new(options)
-      cmd.execute
-    end
+    register Kurgan::List, 'list', 'list', 'list all components in the onestack'
+    tasks["list"].options = Kurgan::List.class_options
+
+    register Kurgan::Search, 'search', 'search [component]', "search for a component and it's release history"
+    tasks["search"].options = Kurgan::Search.class_options
 
+    register Kurgan::Inspect, 'inspect', 'inspect', "inspect a cfhighlander files of it's components"
+    tasks["inspect"].options = Kurgan::Inspect.class_options
 
   end
 end

data/lib/kurgan/component.rb

@@ -27,6 +27,10 @@ module Kurgan
       template('templates/cfndsl.rb.tt', "#{@dir}/#{name}.cfndsl.rb")
     end
 
+    def create_readme
+      template "templates/README.md.component.tt", "#{@dir}/README.md"
+    end
+
     def create_default_config_test
       @test_name = 'default'
       template('templates/test.yaml.tt', "#{@dir}/tests/#{@test_name}.test.yaml")

data/lib/kurgan/extend.rb

@@ -0,0 +1,47 @@
+module Kurgan
+  class Extend < Thor::Group
+    include Thor::Actions
+
+    argument :component
+
+    class_option :name, aliases: :n, type: :string
+    class_option :version, aliases: :v, type: :string
+    
+    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}, are you in a cfhighlander project folder?"
+      end
+    end
+
+    def get_component_name
+      @name = options[:name] || component
+    end
+
+    def create_sub_dir_for_extended_component
+      empty_directory @name
+    end
+
+    def get_template_version
+      @template = options[:version] ? "#{component}@#{options[:version]}" : component
+      say "extending #{@template} to the #{@cfhighlander_template.split('.')[0]} project"
+    end
+
+    def create_cfhighlander_files
+      opts = {template: @template, name: @name}
+      template('templates/cfhighlander.extend.rb.tt', "#{@name}/#{@name}.cfhighlander.rb", opts)
+      template('templates/config.yaml.tt', "#{@name}/#{@name}.config.yaml")
+      template('templates/cfndsl.rb.tt', "#{@name}/#{@name}.cfndsl.rb")
+    end
+
+    def add_component
+      insert_into_file @cfhighlander_template, "\tComponent name: '#{@name}', template: '#{@name}'\n\n", :before => /^end/
+    end
+
+  end
+end
+  

data/lib/kurgan/github.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'json'
+
+module Kurgan
+  class GitHub
+
+    GITHUB_URL = "https://api.github.com"
+    GITHUB_ORG = "theonestack"
+
+    def self.get_repos
+      url = "#{GITHUB_URL}/orgs/#{GITHUB_ORG}/repos"
+      response = Faraday.get(url, {type: 'public', per_page: 100}, {'Accept' => 'Accept: application/vnd.github.v3+json'})
+
+      if response.status != 200
+        return nil
+      end
+      
+      repos = JSON.parse(response.body, symbolize_names: true)
+      return repos.select {|repo| repo[:name].start_with?('hl-component')}
+    end
+
+    def self.get_releases(component)
+      url = "#{GITHUB_URL}/repos/#{GITHUB_ORG}/hl-component-#{component}/releases"
+      response = Faraday.get(url, {}, {'Accept' => 'Accept: application/vnd.github.v3+json'})
+      
+      if response.status != 200
+        return nil
+      end
+      
+      return JSON.parse(response.body, symbolize_names: true)
+    end
+
+  end
+end

data/lib/kurgan/init.rb

@@ -36,33 +36,39 @@ module Kurgan
 
     def create_cfhighlander_template
       opts = {parameters: @parameters, components: @components, description: @description}
-      template('templates/cfhighlander.rb.tt', "#{@dir}/#{name}.cfhighlander.rb", opts)
+      template 'templates/cfhighlander.rb.tt', "#{@dir}/#{name}.cfhighlander.rb", opts
     end
 
     def create_config_yaml
       template 'templates/config.yaml.tt', "#{@dir}/#{name}.config.yaml"
     end
 
+    def create_readme
+      template "templates/README.md.project.tt", "#{@dir}/README.md"
+    end
+
     def git_init
-      if yes?("git init project?")
+      if yes? "git init project?"
         run "git init #{@dir}"
         template 'templates/gitignore.tt', "#{@dir}/.gitignore"
-        template "templates/README.md.tt", "#{@dir}/README.md"
       else
         say "Skipping git init", :yellow
       end
     end
 
     def ci_init
-      if yes?("Setup a CI pipeline?")
-        ci = ask "CI flavour", limited_to: ['jenkins', 'travis', 'codebuild']
+      if yes? "Setup a CI pipeline?"
+        ci = ask "CI flavour", limited_to: ['github', 'jenkins', 'codebuild']
         case ci
+        when 'github'
+          template 'templates/github_actions.yaml.tt', "#{@dir}/.github/workflows/rspec.yaml"
+          insert_into_file "#{@dir}/README.md", 
+            "![cftest](https://github.com/theonestack/hl-component-#{name}/actions/workflows/rspec.yaml/badge.svg)\n\n", 
+            :after => /^# #{name} CfHighlander Component\n\n/
         when 'jenkins'
-          template('templates/Jenkinsfile.tt', "#{@dir}/Jenkinsfile")
-        when 'travis'
-          template('templates/travis.yml.tt', "#{@dir}/.travis.yml")
+          template 'templates/Jenkinsfile.tt', "#{@dir}/Jenkinsfile"
         when 'codebuild'
-          template('templates/codebuild.yaml.tt', "#{@dir}/.codebuild.yaml")
+          template 'templates/codebuild.yaml.tt', "#{@dir}/.codebuild.yaml"
         end
       else
         say "Skipping CI setup", :yellow

data/lib/kurgan/inspect.rb

@@ -0,0 +1,50 @@
+require "thor"
+require 'terminal-table'
+
+module Kurgan
+  class Inspect < Thor::Group
+    include Thor::Actions
+
+    def get_cfhighlander_template
+      @cfhighlander_rb = Dir['*.cfhighlander.rb'][0]
+      if @cfhighlander_rb.nil?
+        raise "No cfhighlander.rb file found in #{Dir.pwd}"
+      end
+    end
+
+    def get_project_name
+      @project_name = @cfhighlander_rb.split('.').first
+    end
+
+    def get_components
+      cfhighlander_file = File.read(@cfhighlander_rb)
+      raw_components = cfhighlander_file.scan(/template:\s?(.*?)\s/).flatten
+      
+      @components = raw_components.map do |template_str|
+        template = template_str.strip.gsub(/("|'|,)/, '').split(/(@|#)/)        
+        { template: template.first, version: (template.size > 1 ? template.last : "not found") }
+      end
+    end
+
+    def check_versions
+      @components.each do |comp|
+        releases = Kurgan::GitHub.get_releases(comp[:template])
+        if !releases.nil? && releases.any? 
+          latest_release = releases.sort_by { |r| r[:tag_name] }.reverse.first
+          comp[:latest_release] = latest_release[:tag_name]
+        else
+          comp[:latest_release] = 'not found'
+        end
+      end
+    end
+
+    def display
+      puts Terminal::Table.new(
+        :title => "Project: #{@project_name}",
+        :headings => ['Component', 'Version', 'Latest Release'], 
+        :rows => @components.map {|comp| [comp[:template], comp[:version], comp[:latest_release]] }
+      )
+    end
+
+  end
+end

data/lib/kurgan/list.rb

@@ -1,58 +1,24 @@
-require 'open-uri'
+require "thor"
+require 'terminal-table'
+require 'kurgan/github'
 
 module Kurgan
-  class List
+  class List < Thor::Group
+    include Thor::Actions
 
-    def initialize(options)
-      @filter = options[:filter]
-      @component = options[:component]
-      if options[:update] || !File.exists?(Kurgan.components_file)
-        update_component_list
+    def get_repos
+      repos = Kurgan::GitHub.get_repos()
+      if repos.nil?
+        abort "Error: Somthing went wrong with connecting to the github api"
       end
-      content = File.read(Kurgan.components_file)
-      @components = JSON.parse(content)['components']
+      @hl_repos = repos.map {|repo| [repo[:name], repo[:url], repo[:updated_at]]}
     end
 
-    def execute
-      puts "\n\s\s============================="
-      puts "\s\s## CfHighlander Components ##"
-      puts "\s\s=============================\n\n"
-      if @component
-        return component
-      elsif @filter
-        return filter
-      else
-        return all
-      end
-    end
-
-    def component
-      components = @components.select { |comp| comp['name'].include? @component }
-      abort "no match for component #{@component}" if !components.any?
-      components.each { |comp| puts "\s\s\s\s#{comp['name']} (#{comp['versions'].join(', ')})" }
-    end
-
-    def filter
-      components = @components.select { |comp| comp['filter'].include? @filter }
-      abort "no match for filter #{@filter}" if !components.any?
-      components.each { |comp| format(comp['name'],comp['latest']) }
-    end
-
-    def all
-      @components.each { |comp| format(comp['name'],comp['latest']) }
-    end
-
-    def format(name,version)
-      version = version != "" ? version : 'latest'
-      puts "\s\s\s\s#{name}@#{version}"
-    end
-
-    def update_component_list
-      puts "Updating components list"
-      FileUtils.mkdir_p File.dirname(Kurgan.components_file)
-      content = open('https://s3-ap-southeast-2.amazonaws.com/cfhighlander-component-specification/components.json').read
-      File.open(Kurgan.components_file, 'w') { |f| f.puts content }
-      puts "Succesfully updated components list #{Kurgan.components_file}"
+    def display
+      puts Terminal::Table.new( 
+        :headings => ['Component', 'Git URL', 'Last Updated'], 
+        :rows => @hl_repos.sort
+      )
     end
 
   end

data/lib/kurgan/search.rb

@@ -0,0 +1,33 @@
+require "thor"
+require 'terminal-table'
+require 'kurgan/github'
+
+module Kurgan
+  class Search < Thor::Group
+    include Thor::Actions
+
+    argument :component
+
+    def get_releases    
+      releases = Kurgan::GitHub.get_releases(component)
+      if releases.nil?
+        abort "ERROR: unable to find component in theonestack"
+      end
+
+      if releases.any?
+        @rows = releases.map {|release| [release[:tag_name], release[:name], release[:published_at], release[:html_url]]}
+      else
+        tags = Kurgan::GitHub.get_tags(component)
+      end
+    end
+
+    def display
+      puts Terminal::Table.new(
+        :title => "Component: #{component}",
+        :headings => ['Version', 'name', 'Published', 'URL'], 
+        :rows => @rows.sort.reverse
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,77 @@
+# <%= name %> CfHighlander Component
+
+<!--- add component description --->
+
+```bash
+kurgan add <%= name %>
+```
+
+## Requirements
+
+## Parameters
+
+| Name | Use | Default | Global | Type | Allowed Values |
+| ---- | --- | ------- | ------ | ---- | -------------- |
+
+
+## Configuration
+
+<!--- add component config examples --->
+
+```yaml
+example_config: test
+```
+
+## Outputs/Exports
+
+| Name | Value | Exported |
+| ---- | ----- | -------- |
+
+
+## Development
+
+```bash
+gem install cfhighlander
+```
+
+or via docker
+
+```bash
+docker pull theonestack/cfhighlander
+```
+
+### Testing
+
+Generate cftest
+
+```bash
+kurgan test example
+```
+
+Run cftest
+
+```bash
+cfhighlander cftest -t tests/example.test.yaml
+```
+
+or run all tests
+
+```bash
+cfhighlander cftest
+```
+
+Generate spec tests
+
+```bash
+kurgan test example --type spec
+```
+
+run spec tests
+
+```bash
+gem install rspec
+```
+
+```bash
+rspec
+```

data/lib/kurgan/templates/{README.md.tt → README.md.project.tt}

@@ -1,4 +1,4 @@
-# <%= name %> CfHighlander <%= @type %>
+# <%= name %> CfHighlander Project
 
 ## Cfhighlander Setup
 
@@ -24,7 +24,7 @@ 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

data/lib/kurgan/templates/cfhighlander.extend.rb.tt

@@ -0,0 +1,4 @@
+CfhighlanderTemplate do
+  Name '<%= config[:name] %>'
+  Extends '<%= config[:template] %>'
+end

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

@@ -1,6 +1,3 @@
 CloudFormation do
   ## Add your cfndsl resources here
-  SNS_Topic(:Topic) {
-    TopicName topic_name if defined? topic_name
-  }
 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/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/test.rb

@@ -1,10 +1,12 @@
+require 'yaml'
+
 module Kurgan
   class Test < Thor::Group
     include Thor::Actions
 
     argument :test_name
 
-    class_option :type, aliases: :t, type: :string, enum: %w(config), default: 'config'
+    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
@@ -16,6 +18,7 @@ module Kurgan
       if @cfhighlander_template.nil?
         raise "No cfhighlander.rb file found in #{Dir.pwd}"
       end
+      @component_name = @cfhighlander_template.split('.').first
     end
 
     def create_test
@@ -23,6 +26,14 @@ module Kurgan
       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

data/lib/kurgan/version.rb

@@ -1,3 +1,3 @@
 module Kurgan
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/list.rb

@@ -0,0 +1,25 @@
+require "thor"
+require 'faraday'
+require 'json'
+require 'terminal-table'
+
+module Kurgan
+  class List < Thor::Group
+    include Thor::Actions
+
+    def get_repos
+      url = 'https://api.github.com/orgs/theonestack/repos'
+      response = Faraday.get(url, {type: 'public', per_page: 100}, {'Accept' => 'Accept: application/vnd.github.v3+json'})
+      repos = JSON.parse(response.body, symbolize_names: true)
+      @hl_repos = repos.select {|repo| repo[:name].start_with?('hl-component')}.map {|repo| [repo[:name], repo[:url], repo[:updated_at]]}
+    end
+
+    def display
+      puts Terminal::Table.new( 
+        :headings => ['Component', 'Git URL', 'Last Updated'], 
+        :rows => @hl_repos.sort
+      )
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kurgan
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,6 +24,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +84,14 @@ dependencies:
     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 +100,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
@@ -72,27 +113,35 @@ files:
 - lib/kurgan.rb
 - lib/kurgan/add.rb
 - lib/kurgan/component.rb
+- lib/kurgan/extend.rb
+- lib/kurgan/github.rb
 - lib/kurgan/globals.rb
 - lib/kurgan/init.rb
+- lib/kurgan/inspect.rb
 - lib/kurgan/list.rb
 - lib/kurgan/projects.rb
+- lib/kurgan/search.rb
 - lib/kurgan/templates/Jenkinsfile.tt
 - lib/kurgan/templates/MITLICENSE
-- lib/kurgan/templates/README.md.tt
+- lib/kurgan/templates/README.md.component.tt
+- lib/kurgan/templates/README.md.project.tt
+- lib/kurgan/templates/cfhighlander.extend.rb.tt
 - lib/kurgan/templates/cfhighlander.rb.tt
 - 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
+- list.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:
@@ -108,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+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"

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

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-install:
-  - gem install cfhighlander cfn-nag
-before_script:
-  - cfndsl -u
-<%- if @type == 'component' -%>
-script:
-  - 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 -%>