minke 0.16.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTFjNWY4NWEwYTEwYWUyMmQ3ZTlkYzZkMTZhODA4N2IzNDlhYjMyYQ==
+    ODY0MTRkNGJkNjIzNWVjZWExZGI3YzEzZTg5NWU2NmY1MTNjN2Q3NQ==
   data.tar.gz: !binary |-
-    MzNhZjliOGNjYWY4YTU4ZDg3MGIzYmJkMTk4NzVlZDc3ZjcxYjM4Nw==
+    NjU0M2JjMjMzNDUyNGFlOTg5ODE3ZTE3NzYyM2E5NDhhNDBlOGJjNA==
 SHA512:
   metadata.gz: !binary |-
-    NmQ4MGE0Y2I0NDYwMzMxYmYwMjNmZjk1OTZiYTE5ZDcxYThiNmZjMmVkZDUz
-    YWFiNTQ1YmUyYzU4MTc0ODE5ZDM5ZWViMmE3MDQzZWFkYjNkNTg1OGIxODQ3
-    NjU0OGZlMzBiNjAxOGIyYjc4MjI2MDZkYWZjOWE5NzdmNDAxMGU=
+    NWY0NjJiZmIxYmI3NGNkMDk3ZDIzNTEwZTc1M2NjNGJjMjA3OTVmNTNhMTlj
+    YzVmZjFmMTRlNDI5ZGMyYTk1NDY4Yzg4Y2E0ZmQwZTE2Mjk1Njg3ZGY1OWQ2
+    NDc1N2NmMGI4NzNiNDFlZWQ4YWVjNjMyYmI1OGI5Y2ZjMzBkNjc=
   data.tar.gz: !binary |-
-    YWFiN2IzYzA2ODI5MGQ0NDIxMjk0ODMyYjBiZmI5Nzk2NWZmYzQxNjgzZjM1
-    MWZiNzlmZWUxMzU3ODdlYjY3YTE2ZGU2MzE3ZDg4YjQ1NzhjMWQwZmI4YWJk
-    MTA2NjI4NTUzMTI1NGZkMTJiNjg2MWNiODhiOTYxZTNkNTdiMzA=
+    MzVhM2U2Njc3OWVjMDc4MTY4ZjJiMDIxNzNhZjcyZGVlNDQzZWZkMGU1MjY5
+    YWNhZGIxZjg0ZDNjYTk1ZTk1ZmRlN2NmYWI2MzM3Yzc2MTEyMDU0YjI4ODM4
+    NTAwMDhmZmZkNWE4NzNiOTBjOGU1ZjZkMWVhNmM1ZGE2MGQ5Y2E=

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/.ruby-version

@@ -1 +1 @@
-2.2.4
+2.3.1

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-- 2.2.4
+- 2.3.1
+env:
+  global:
+    secure: "ND69gJ0h5JB0I7mogcjIwAr+3lc815M0L9i9xg7CKVdtMKyuLIT/QKoqAJ9ivnYCapnRrxweRco82VlrFz6hru5phhEiCHLLmdyYngZcjVOnTWVLanc9juQ+cz/65lqJl7MbwZxKbdurh4/2FzGoTCMdjIYzMDk+pT0hHHiZ+8p492mj0hdglGX1WfoQJvIsvR94jy+JEDsjzlB6odk+uhD2qlhK0/k2UDG8tlbEPp/zf2dvonhud3TmdvkiVTNKPS1kpB1BJCwkhNfg7ZRKkt0FMMR/g1GAfHlRE/FiUaVCyurUaUVnfAUvhuGZ28XhHotRCogP6YV6hkpWy7wyelool4c+CzSho4cdEwNFiNXME5wbpMUiZN5w9YTBBK11u2uPrhw2tUvJtjNQdvvKKdQw404hPcVaLsGaviK3G6qC1huo3kRQW51HgBF8J99+icCDgTyM+m+iJrQwCGU+darpv/ozpczoM9avE6EOF1Nu+35iRAdu5o4KR4k5EDf7AlXck1B0n5aAYj7t624cVKIF9vusOq7nmT63N8m37ZBWz09aAHasW0bm6ReB6+uOFM776Umh3/A6hr0zYrqiaQuk1zw2PNR5twvrqSLqEAwEK9ozROe3bWMdFlZhoCWNzaKNqMCt0O8B1k5xPClx3uhI63XeykxMWMDFLfvQNtw="
 install: bundle
 script:
 - rake test

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in go_builder.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+#gem 'minke-generator-go', :path => '/Users/nicj/Developer/gems/minke-generator-go'
+#gem 'minke-generator-node', :path => '/Users/nicj/Developer/gems/minke-generator-node'
+#gem 'minke-generator-spring', :github => 'notonthehighstreet/minke-generator-spring', :branch => 'master'

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec", failed_mode: :focus do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -1,20 +1,23 @@
 # Minke
 
+[![Join the chat at https://gitter.im/nicholasjackson/minke](https://badges.gitter.im/nicholasjackson/minke.svg)](https://gitter.im/nicholasjackson/minke?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ## NOTE:
-Version 0.13.0 of the gem introduces breaking changes to the configuration files in order to support multiple language builds for swift and go.  Please use version 0.12.0 or upgrade your config to the new specification shown below.  
+Version 1 is pretty much a complete rewrite which supports new generator plugins to scaffold applications and greater compatibility for running docker compose on CI environments.  Documentation is coming soon (as in hopefully tomorrow), but for the moment I apologize but the documentation below is a little out of date.
+
+Version 1.0 is not compatible with previous versions of minke however upgrading is not so painful, full instructions will be updated shortly.   In the mean time please continue to use the previous stable 0.1.5 [https://github.com/nicholasjackson/minke/tree/0.1.5](https://github.com/nicholasjackson/minke/tree/0.1.5).
 
-**Version 0.15.0**  
+**Version 1.0**  
 [![Build Status](https://travis-ci.org/nicholasjackson/minke.svg?branch=master)](https://travis-ci.org/nicholasjackson/minke)
 
 Minke is an opinionated build system for Microservices and Docker, like a little envelope of quality it scaffolds the build, run and test (unit test and functional tests) phases of your microservice project allowing you to simply run and test your images using Docker Compose.  Currently supporting Google's Go, and experimental support for Swift, extensions are planned for Node.js or HTML / Javascript sites with Grunt or Gulp based builds.
 
-## Supported languages
-- Go
-- Swift
-
-## Languages coming soon
-- Node
-- Java
+## Generators
+- Go - Go Microservice Template
+- Java - Spring Boot
+- Swift - Kitura (Coming Soon)
+- Node - ExpressJS (Coming Soon)
+- Ruby - Rails (Coming Soon)
 
 ## Installation
 

data/bin/minke

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'minke'
+
+ASCII_ART = <<eos
+888b     d888 d8b          888
+8888b   d8888 Y8P          888
+88888b.d88888              888
+888Y88888P888 888 88888b.  888  888  .d88b.
+888 Y888P 888 888 888 "88b 888 .88P d8P  Y8b
+888  Y8P  888 888 888  888 888888K  88888888
+888   "   888 888 888  888 888 "88b Y8b.
+888       888 888 888  888 888  888  "Y8888
+eos
+
+puts ""
+puts ASCII_ART
+puts ""
+puts "Version: #{Minke::VERSION}"
+puts ""
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: example.rb [options]"
+
+  opts.on('-g', '--generator GENERATOR', 'Generator plugin to use') { |v| options[:generator] = v }
+  opts.on('-o', '--output OUTPUT', 'Output folder') { |v| options[:output] = v }
+  opts.on('-a', '--application_name NAME', 'Application name') { |v| options[:name] = v }
+  opts.on('-n', '--namespace NAMESPACE', 'Application namespace') { |v| options[:namespace] = v }
+
+end.parse!
+
+# load the installed generators
+variables = Minke::Generators::ConfigVariables.new.tap do |v|
+  v.application_name = options[:name]
+  v.namespace = options[:namespace]
+  v.src_root = File.expand_path(options[:output]) unless options[:output] == nil
+end
+processor = Minke::Generators::Processor.new variables
+processor.load_generators
+
+
+if options[:generator] == nil || options[:output] == nil || options[:name] == nil || options[:namespace] == nil
+  puts "Please specify options use: minke --help for help on command line options"
+  exit 0
+end
+
+processor.process options[:generator], options[:output]

data/examples/config_go.yml

@@ -1,7 +1,5 @@
-go:
-  namespace: 'github.com/nicholasjackson'
-  application_name: 'event-sauce'
-  comand: '/usr/local/go/bin/go'
+namespace: 'github.com/nicholasjackson'
+application_name: 'event-sauce'
 docker_registry:
   url: <%= ENV['DOCKER_REGISTRY_URL'] %>
   user: <%= ENV['DOCKER_REGISTRY_USER'] %>
@@ -9,26 +7,47 @@ docker_registry:
   email: <%= ENV['DOCKER_REGISTRY_EMAIL'] %>
   namespace: <%= ENV['DOCKER_NAMESPACE'] %>
 docker:
-  docker_file: './'
-  compose_file: './'
+  build_image: [optional]
+  build_docker_file: [optional]
+  application_docker_file: './dockerfiles/event-sauce/Dockerfile'
+  application_compose_file: './dockercompose/event-sauce/docker-compose.yml'
+fetch:
+  include: true
+build:
+  pre:
+    tasks:
+      -
+    copy_assets:
+      -
+  docker:
+    application_compose_file: './dockercompose/event-sauce/docker-compose.yml'
+  post:
+    tasks:
+      -
+    copy:
+      -
+        from: <%= "#{ENV['GOPATH']}/src/github.com/nicholasjackson/event-sauce/event-sauce" %>
+        to: './docker/event-sauce'
+      -
+        from: './swagger_spec/swagger.yml'
+        to: './dockerfile/event-sauce/swagger_spec/swagger.yml'
 run:
-  consul_loader:
-    enabled: true
-    config_file: './config.yml'
-    url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
+  pre:
+    consul_loader:
+      config_file: './config.yml'
+      url: http://<%= get_public_server_for 'test2:9500' %> # specifying the url as a coompose server name and private port will auto resolve
+  docker:
+    application_compose_file: './dockercompose/event-sauce/docker-compose-alternate.yml'
+  post:
+    tasks:
+      - wait_for_elastic_search
 cucumber:
-  consul_loader:
-    enabled: true
-    config_file: './config.yml'
-    url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
-  health_check:
-    enabled: true
-    url: <%= "http://#{ENV['DOCKER_IP']}:8001/v1/health" %>
-after_build:
-  copy_assets:
-    -
-      from: <%= "#{ENV['GOPATH']}/src/github.com/nicholasjackson/event-sauce/event-sauce" %>
-      to: './docker/event-sauce'
-    -
-      from: './swagger_spec/swagger.yml'
-      to: './dockerfile/event-sauce/swagger_spec/swagger.yml'
+  pre:
+    consul_loader:
+      config_file: './config.yml'
+      url: http://<%= get_public_server_for 'consul:8500' %>
+    health_check:
+      url: http://<%= get_public_server_for 'test2:8001' %>/v1/health
+  post:
+    tasks:
+      - 'wait_for_elastic_search'

data/lib/minke/config/config.rb

@@ -0,0 +1,326 @@
+module Minke
+  module Config
+    ##
+    # Config represents project level configuration for minke builds
+    class Config
+      ##
+      # the namespace for the application
+      #
+      # [Required]
+      attr_accessor :namespace
+
+      ##
+      # the name of the application
+      #
+      # [Required]
+      attr_accessor :application_name
+
+      ##
+      # the name of the generator to use
+      #
+      # [Required]
+      attr_accessor :generator_name
+
+      ##
+      # Docker registry settings instance of Minke::Config::DockerRegistrySettings
+      #
+      # [Optional]
+      attr_accessor :docker_registry
+
+      ##
+      # Docker settings for tasks, any items defined in this section will override
+      # the defaults provided inside the generator.
+      # instance of Minke::Config::DockerSettings
+      #
+      # [Required]
+      attr_accessor :docker
+
+      ##
+      # Settings for the fetch packages phase
+      # instance of Minke::Config::Task
+      #
+      # [Optional] if not provided the fetch commands will not be executed
+      attr_accessor :fetch
+
+      ##
+      # Settings for the build image phase
+      # instance of Minke::Config::Task
+      #
+      # [Optional] if not provided the build commands will not be executed
+      attr_accessor :build
+
+      ##
+      # Settings for the run application phase
+      # instance of Minke::Config::Task
+      #
+      # [Optional] if not provided the run commands will not be executed
+      attr_accessor :run
+
+      ##
+      # Settings for the run application phase
+      # instance of Minke::Config::Task
+      #
+      # [Optional] if not provided the test commands will not be executed
+      attr_accessor :test
+
+      ##
+      # Settings for the cuccumber functional test phase
+      # instance of Minke::Config::Task
+      #
+      # [Optional] if not provided the cucumber commands will not be executed
+      attr_accessor :cucumber
+
+      ##
+      # Returns the docker_compose file for the given section,
+      # if the section overrides application_compose_file then this is returned
+      # otherwise the global file is returned
+      # Parameters
+      # - :fetch
+      # - :build
+      # - :run
+      # - :test
+      # - :cucumber
+      def compose_file_for section
+        file = docker.application_compose_file unless docker.application_compose_file == nil
+
+        if self.send(section) != nil &&
+           self.send(section).docker != nil &&
+           self.send(section).docker.application_compose_file != nil
+            file = self.send(section).docker.application_compose_file
+        end
+        return file
+      end
+
+      ##
+      # Returns the build_image file for the given section,
+      # if the section overrides build_image then this is returned
+      # otherwise the global build_image is returned
+      # Parameters
+      # - :fetch
+      # - :build
+      # - :run
+      # - :test
+      # - :cucumber
+      def build_image_for section
+        file = docker.build_image unless docker.build_image == nil
+
+        if self.send(section) != nil &&
+           self.send(section).docker != nil &&
+           self.send(section).docker.build_image != nil
+            file = self.send(section).docker.build_image
+        end
+        return file
+      end
+
+      ##
+      # Returns the docker_compose file for the given section,
+      # if the section overrides application_compose_file then this is returned
+      # otherwise the global file is returned
+      # Parameters
+      # - :fetch
+      # - :build
+      # - :run
+      # - :test
+      # - :cucumber
+      def build_docker_file_for section
+        file = docker.build_docker_file unless docker.build_docker_file == nil
+
+        if self.send(section) != nil &&
+           self.send(section).docker != nil &&
+           self.send(section).docker.build_docker_file != nil
+            file = self.send(section).docker.build_docker_file
+        end
+        return file
+      end
+    end
+
+    ##
+    # DockerRegistrySettings encapsulates the settings related to the docker registry
+    class DockerRegistrySettings
+      ##
+      # url of the docker registry to use.
+      #
+      # [Optional]
+      attr_accessor :url
+
+      ##
+      # user to use when logging into a docker registry.
+      #
+      # [Optional]
+      attr_accessor :user
+
+      ##
+      # password to use when logging into a docker registry.
+      #
+      # [Optional]
+      attr_accessor :password
+
+      ##
+      # email to use when logging into a docker registry.
+      #
+      # [Optional]
+      attr_accessor :email
+
+      ##
+      # namespace to use when tagging an image for the docker registry.
+      #
+      # [Required]
+      attr_accessor :namespace
+    end
+
+    ##
+    # DockerSettings encapsulate the configuration used when running builds using docker.
+    class DockerSettings
+      ##
+      # Docker Image to use when building the application source code.
+      #
+      # [Optional]
+      attr_accessor :build_image
+
+      ##
+      # Specific docker settings to allow an override of the defaults provided by the template, you may want to use
+      # this if you require a specific piece of software to be installed on the build container.
+      #
+      # [Optional]
+      attr_accessor :build_docker_file
+
+      ##
+      # Dockerfile to use when creating the final docker image.
+      #
+      # [Required]
+      attr_accessor :application_docker_file
+
+      ##
+      # Docker compose file to use when running and executing cucumber tests.
+      #
+      # [Required]
+      attr_accessor :application_compose_file
+    end
+
+    ##
+    # Task encapsulates the configuration for the various rake tasks like build, run, etc.
+    class Task
+      ##
+      # pre tasks will run before the main task executes.
+      # instance of Minke::Config::TaskRunSettings
+      #
+      # [Optional]
+      attr_accessor :pre
+
+      ##
+      # post tasks will run after the main task executes.
+      # instance of Minke::Config::TaskRunSettings
+      #
+      # [Optional]
+      attr_accessor :post
+
+      ##
+      # docker config allows you to override the main docker configuration on a per task basis.
+      # instance of Minke::Config::TaskRunSettings
+      #
+      # [Optional]
+      attr_accessor :docker
+
+      ##
+      # container_addresses contains an array of Minke::Config::ContainerAddress which holds the details
+      # for the address the public and private ports of any containers which will be started by this
+      # task.
+      attr_accessor :container_addresses
+    end
+
+    ##
+    # TaskRunSettings encapsulates the configuration for the various pre and post sections for each task.
+    # You can use this section to load config into consul, wait for a health check to complete, copy files
+    # or execute other tasks defined in your Rakefile.
+    class TaskRunSettings
+      ##
+      # tasks is an array of strings which point to a defined task in your Rakefile.
+      #
+      # [Optional]
+      attr_accessor :tasks
+
+      ##
+      # consul_loader will specify that the given config file is loaded into Consul.
+      # instance of Minke::Config::ConsulLoader
+      #
+      # [Optional]
+      attr_accessor :consul_loader
+
+      ##
+      # health_check is the string representation of a url to check before continuing with the rest of the
+      # task a successfull 200 response from the endpoint is required to contine.
+      #
+      # [Optional]
+      attr_accessor :health_check
+
+      ##
+      # copy is an array of Copy instances which will be copied before the task continues.
+      # instance of Minke::Config::Copy
+      #
+      # [Optional]
+      attr_accessor :copy
+    end
+
+    ##
+    # ConsulLoader defines the settings and url to be loaded into a running consul instance.
+    class ConsulLoader
+      ##
+      # config_file points to a yaml file of key values to load into consul.
+      #
+      # [Required]
+      attr_accessor :config_file
+
+      ##
+      # url is the url to the running consul instance into which the keys and values will be loaded.
+      #
+      # [Required]
+      attr_accessor :url
+    end
+
+    ##
+    # Copy defines a source and destination of either a file or directory to be copied during a task.
+    class Copy
+      ##
+      # from is the file or directory to copy from.
+      #
+      # [Required]
+      attr_accessor :from
+
+      ##
+      # to is the file or directory to copy to.
+      #
+      # [Required]
+      attr_accessor :to
+    end
+
+    ##
+    # URL represents a url object which is used for health_check and consul_loader locations
+    class URL
+      ##
+      # address of the server i.e 127.0.0.1 or the docker name consul
+      attr_accessor :address
+
+      ##
+      # port which the server is running on
+      # default 80
+      attr_accessor :port
+
+      ##
+      # protocol for the server
+      # - http [default]
+      # - https
+      attr_accessor :protocol
+
+      ##
+      # path for the server
+      # default /
+      attr_accessor :path
+
+      ##
+      # type of the URL
+      # - public
+      # - private used for linked containers
+      attr_accessor :type
+    end
+  end
+end