minke 0.12.0 → 0.13.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGUxM2QwNzc1ZmQ0MzcwYzYyMTk1ZTZlMzk3NWM0MzdkZTg4NDYwNw==
+    YTU3ZjAyMWE2ZGJiNzc4YjEyM2UyN2Q5YTE4NmZlYTc2MjhmMGUxYg==
   data.tar.gz: !binary |-
-    MGFiM2IwN2IyZTgyNjg4MTdjZTlmNmM1ZDliY2U5ZWYzNDBmOGExZQ==
+    NzYwZTE3MjM5ZTI2YzRhYjU0YTczN2E4ZDM4ZDc1Mjk1NTRhY2JlZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDA2ZjYzNTJiNjUzYzJjOTZmNTIyZTkyNDNiMDU0NzhhN2IwNzBmNjg0NDg2
-    ODBjNjk1YTJlNzVlZjkwOGUwMDc2YzhhODZkYWY5NTg2Nzg5MGVlMWI4ODgy
-    MmFhMTk0ZjRhMTEzNWZiNzhiMTU0YTc1YjIwMDY4YzRmY2Y4YTc=
+    YWE2MzAwMTM2MmM3ZWVhYWNlZGRlZWQzZWNmMDQwMTg5MDcwMjBhNjU5MDM5
+    ODBjOGYyZTQ1M2ViMjI0MTUwOWEyMzVjMzQwNDYwOGRiNTY1OTIxNDJkMTk2
+    NTEzYWI3NzljZjg5Y2E4MWM1NWJiMjk1YTU5MjE5MTcyOTFjZGQ=
   data.tar.gz: !binary |-
-    YzFjMGJhNDkyMDFmNGVkMGE0OWFhMWE2MmFhMGI2MjliZDQyYmUzZDc2ZDk0
-    ODQ3NDVkZjdmYTQ2ZjI4YTZmODYzNWZlOWJkMGNkZGE4ZDY4OTY5ZDhmNDcy
-    MzRhMjVjODEwNTc0MzI4NGEyMWI5MzE3MDA2MzhlMzcyOWI2YjE=
+    MGNiOTNjYjQ0ZmJiMGEyZGZhNGJjM2RmMzFmYmQ1ZDkxNGZlYTJkMjM4MWNm
+    ZTI0NjQwNTNlMjgxNzM4M2JhMjE4YjRmOTgxZGUxYTdiZjAyODExNGZmNzEy
+    M2I1MDA2YTQxNDgyY2M2NDg1OWExODRjZjA1NWVlNjc2YWJhNjg=

data/README.md

@@ -1,7 +1,12 @@
 # Minke
+
+## 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 0.13.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, extensions are planned for Node.js or HTML / Javascript sites with Grunt or Gulp based builds. 
+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.
 
 ## Installation
 
@@ -63,9 +68,9 @@ The config file config.yml is where you set the various configuration for the bu
 
 ### Example Config File
 ```yaml
-go:
-  namespace: 'github.com/nicholasjackson'
-  application_name: 'event-sauce'
+namespace: 'github.com/nicholasjackson'
+application_name: 'event-sauce'
+language: go
 docker_registry:
   url: <%= ENV['DOCKER_REGISTRY_URL'] %>
   user: <%= ENV['DOCKER_REGISTRY_USER'] %>
@@ -73,18 +78,23 @@ docker_registry:
   email: <%= ENV['DOCKER_REGISTRY_EMAIL'] %>
   namespace: <%= ENV['DOCKER_NAMESPACE'] %>
 docker:
-  docker_file: './'
-  compose_file: './'
-  build_args:
-    image: 'golang:latest'
-    env:
-      - 'CGO_ENABLED=0' # used for alpine linux static linking
-    working_directory: '/go/src/github.com/nicholasjackson/event-sauce'
+  docker_file: './dockerfiles/event-sauce/Dockerfile'
+  compose_file: './dockercompose/event-sauce/docker-compose.yml'
+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'
 run:
   consul_loader:
     enabled: true
     config_file: './config.yml'
     url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
+  docker:
+    compose_file: './dockercompose/event-sauce/docker-compose-alternate.yml'
 cucumber:
   consul_loader:
     enabled: true
@@ -95,20 +105,13 @@ cucumber:
     url: <%= "http://#{ENV['DOCKER_IP']}:8001/v1/health" %>
   after_start:
     - 'wait_for_elastic_search'
-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'
 ```
 
-#### go:
+#### head:
 This section contains the configuration for the build process.  
 **namespace:** namespace for your application code within your GOPATH, this is generally the same as your repository.  
 **application_name:** name of the built binary.  
+**language** (go|swift) language type of the build swift is currently experimental and uses the v3 dev branch which is compatible with Kitura
 
 #### docker_registry:
 This section contains the configuration for the docker registry to push the image to.  Images are pushed to the registry prefixed with the namespace and application_name, e.g. nicholasjackson/event-sauce:latest.   
@@ -118,16 +121,38 @@ This section contains the configuration for the docker registry to push the imag
 **email:** email address to use when logging into the registry.  
 **namespace:** namespace of your image to use when pushing the image to the registry.  
 
+#### after_build:
+This section allows you to copy assets such as binaries or files which you would like to include into your Docker image.
+##### copy_assets:  
+An array of elements with the following parameters:  
+**from:** the source file or directory  
+**to:** the destination file or directory
+
 #### docker:
 This section contains configuration for the Docker build and run process.  
 **docker_file:** path to the folder containing your Dockerfile used by the build_server task.  
 **compose_file:** path to your docker-compose file for run and cucumber tasks.  
 
 #### run:
+The run section defines config for running your microservice with Docker Compose.
 ##### consul_loader:
 When the application is run using docker-compose you can load some default config into your consul server.  Told you this was opinionated, if you are building microservices you are using consul right?  
 **enabled:** boolean determining if this feature is enabled.  
 **config_file:** path to a yaml file containing the key values you would like to load into consul. consul_loader flattens the structure of your yaml file and converts this into key values. For more information please see []()
+##### docker:
+This section allows you to override the docker compose file specified in the main section incase you would like a different config for testing.  
+**compose_file:** path to your docker-compose file for run and cucumber tasks.
+##### after_start:
+This section is an array of rake tasks which will be run after docker compose has started, you can define these rake tasks in your main Rakefile.  e.g.  
+  - 'wait_for_elastic_search'
+  - 'es:create_indexes'
+
+#### cucumber:
+The cucumber section defines config for running and testing your microservice with Docker Compose and cucumber, the config options are the same as in **run:** with the addition of health_check.
+##### health_check:
+After the Docker Compose startup the application can wait until the main application has started before running the cucumber tests, to enable this specify true for the enabled: section then specify your health check url.  
+**enabled** (true|false) enable or disable the health check.  
+**url** url to use for health checks.  
 
 ## Development
 

data/examples/{config.yml → config_go.yml}

@@ -11,11 +11,6 @@ docker_registry:
 docker:
   docker_file: './'
   compose_file: './'
-  build_args:
-    image: 'golang:latest'
-    env:
-      - 'CGO_ENABLED=0' # used for alpine linux static linking
-    working_directory: '/go/src/github.com/nicholasjackson/event-sauce'
 run:
   consul_loader:
     enabled: true

data/examples/config_swift.yml

@@ -0,0 +1,32 @@
+swift:
+  application_name: 'event-sauce'
+docker_registry:
+  url: <%= ENV['DOCKER_REGISTRY_URL'] %>
+  user: <%= ENV['DOCKER_REGISTRY_USER'] %>
+  password: <%= ENV['DOCKER_REGISTRY_PASS'] %>
+  email: <%= ENV['DOCKER_REGISTRY_EMAIL'] %>
+  namespace: <%= ENV['DOCKER_NAMESPACE'] %>
+docker:
+  docker_file: './'
+  compose_file: './'
+run:
+  consul_loader:
+    enabled: true
+    config_file: './config.yml'
+    url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
+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'

data/lib/minke/commands/go.rb

@@ -0,0 +1,27 @@
+module Minke
+  module Commands
+    class Go
+      def commands
+        {
+          :build => {
+            :get => ['go','get','-t','-v','-d','./...'],
+            :build => ['go','build','-a','-installsuffix','cgo','-ldflags','\'-s\'','-o', "application"],
+            :test => ['go','test','./...']
+          },
+          :docker => {
+            :image => 'golang:latest',
+            :env => ['CGO_ENABLED=0'],
+            :binds => ["#{ENV['GOPATH']}/src:/go/src"],
+            :working_directory => "#{working_directory}"
+          }
+        }
+      end
+
+      def working_directory
+        dir = File.expand_path('../.')
+        gopath = "#{ENV['GOPATH']}"
+        new_dir = "/go" + dir.gsub(gopath,'')
+      end
+    end
+  end
+end

data/lib/minke/commands/swift.rb

@@ -0,0 +1,24 @@
+module Minke
+  module Commands
+    class Swift
+      def commands
+        {
+          :build => {
+            :build => ['swift', 'build', '-Xcc', '-fblocks'],
+            :test => ['ls', '-ls'],
+          },
+          :docker => {
+            :image => 'ibmcom/kitura-ubuntu:latest',
+            :binds => ["#{source_directory}:/src"],
+            :working_directory => "/src"
+          }
+        }
+      end
+
+      def source_directory
+        Dir.pwd if File.exists?('Package.swift')
+        File.expand_path('../.') if File.exists?('../Package.swift')
+      end
+    end
+  end
+end

data/lib/minke/{go_docker.rb → docker.rb}

@@ -1,5 +1,5 @@
 module Minke
-  class GoDocker
+  class Docker
     def self.get_docker_ip_address
     	if !ENV['DOCKER_HOST']
     		return "127.0.0.1"
@@ -15,7 +15,7 @@ module Minke
 
     def self.find_image image_name
     	found = nil
-    	Docker::Image.all.each do | image |
+    	::Docker::Image.all.each do | image |
     		found = image if image.info["RepoTags"].include? image_name
     	end
 
@@ -37,7 +37,7 @@ module Minke
     end
 
     def self.find_running_container
-    	containers = Docker::Container.all(:all => true)
+    	containers = ::Docker::Container.all(:all => true)
     	found = nil
 
     	containers.each do | container |
@@ -52,9 +52,9 @@ module Minke
     def self.create_and_start_container args
     	# update the timeout for the Excon Http Client
     	# set the chunk size to enable streaming of log files
-    	Docker.options = {:chunk_size => 1, :read_timeout => 3600}
+    	::Docker.options = {:chunk_size => 1, :read_timeout => 3600}
 
-    	container = Docker::Container.create(
+    	container = ::Docker::Container.create(
     		'Image' => args['build_args']['image'],
     		'Cmd' => ['/bin/bash'],
     		'Tty' => true,
@@ -69,13 +69,13 @@ module Minke
     def self.create_and_run_container args, cmd
     	# update the timeout for the Excon Http Client
     	# set the chunk size to enable streaming of log files
-      Docker.options = {:chunk_size => 1, :read_timeout => 3600}
-      container = Docker::Container.create(
-    		'Image' => args['build_args']['image'],
+      ::Docker.options = {:chunk_size => 1, :read_timeout => 3600}
+      container = ::Docker::Container.create(
+    		'Image' => args[:build_config][:docker][:image],
     		'Cmd' => cmd,
-    		"Binds" => ["#{ENV['GOPATH']}/src:/go/src"],
-    		"Env" => args['build_args']['env'],
-    		'WorkingDir' => args['build_args']['working_directory'])
+    		"Binds" => args[:build_config][:docker][:binds],
+    		"Env" => args[:build_config][:docker][:env],
+    		'WorkingDir' => args[:build_config][:docker][:working_directory])
 
       return_code = 0
 

data/lib/minke/helpers.rb

@@ -27,6 +27,9 @@ module Minke
 
     def self.load_config config_file
       @config = YAML.parse(ERB.new(File.read(config_file)).result).transform
+
+      @config[:build_config] = Minke::Commands::Go.new.commands unless @config['language'] != 'go'
+      @config[:build_config] = Minke::Commands::Swift.new.commands unless @config['language'] != 'swift'
     end
 
     def self.copy_files assets

data/lib/minke/rake/app.rake

@@ -3,24 +3,26 @@ namespace :app do
   task :test => ['config:set_docker_env', 'config:load_config', 'docker:fetch_images'] do
     config = Minke::Helpers.config
 
-  	begin
-  		# Get go packages
-      puts "## Go get"
-      container, ret = Minke::GoDocker.create_and_run_container config['docker'], ['go','get','-t','-v','-d','./...']
-    ensure
-  		Minke::GoDocker.delete_container container
-  	end
-
-    puts ""
+    if config[:build_config][:build][:get] != nil
+    	begin
+    		# Get go packages
+        puts "## Get dependent packages"
+        container, ret = Minke::Docker.create_and_run_container config, config[:build_config][:build][:get]
+      ensure
+    		Minke::Docker.delete_container container
+    	end
+
+      puts ""
+    end
 
     begin
   		# Test application
-      puts "## Go test"
-      container, ret = Minke::GoDocker.create_and_run_container config['docker'], ['go','test','./...']
+      puts "## Test application"
+      container, ret = Minke::Docker.create_and_run_container config, config[:build_config][:build][:test]
 
   		raise Exception, 'Error running command' unless ret == 0
     ensure
-  		Minke::GoDocker.delete_container container
+  		Minke::Docker.delete_container container
   	end
 
     puts ""
@@ -34,11 +36,11 @@ namespace :app do
 
   	begin
   		# Build go server
-      container, ret = Minke::GoDocker.create_and_run_container config['docker'], ['go','build','-a','-installsuffix','cgo','-ldflags','\'-s\'','-o', config['go']['application_name']]
+      container, ret = Minke::Docker.create_and_run_container config, config[:build_config][:build][:build]
 
   		raise Exception, 'Error running command' unless ret == 0
     ensure
-  		Minke::GoDocker.delete_container container
+  		Minke::Docker.delete_container container
   	end
 
     puts ""
@@ -60,10 +62,10 @@ namespace :app do
   task :build_server => [:build, :copy_assets] do
     config = Minke::Helpers.config
 
-  	puts "## Building Docker image: #{config['go']['application_name']}"
+  	puts "## Building Docker image"
 
   	Docker.options = {:read_timeout => 6200}
-  	image = Docker::Image.build_from_dir config['docker']['docker_file'], {:t => config['go']['application_name']}
+  	image = Docker::Image.build_from_dir config['docker']['docker_file'], {:t => config['application_name']}
 
     puts ""
   end
@@ -73,7 +75,14 @@ namespace :app do
     puts "## Run application with docker compose"
 
     config = Minke::Helpers.config
-    compose = Minke::DockerCompose.new config['docker']['compose_file']
+
+    if config['run']['docker'] != nil && config['run']['docker']['compose_file'] != nil
+      config_file = config['run']['docker']['compose_file']
+    else
+      config_file = config['docker']['compose_file']
+    end
+
+    compose = Minke::DockerCompose.new config_file
 
   	begin
       compose.up
@@ -120,13 +129,22 @@ namespace :app do
 
   	status = 0
 
-    compose = Minke::DockerCompose.new config['docker']['compose_file']
+    config = Minke::Helpers.config
+
+    if config['cucumber']['docker'] != nil && config['cucumber']['docker']['compose_file'] != nil
+      config_file = config['cucumber']['docker']['compose_file']
+    else
+      config_file = config['docker']['compose_file']
+    end
+
+    compose = Minke::DockerCompose.new config_file
+
   	begin
   	  compose.up
 
       # do we need to run any tasks after the server starts?
-      if config['run']['after_start'] != nil
-        config['run']['after_start'].each do |task|
+      if config['cucumber']['after_start'] != nil
+        config['cucumber']['after_start'].each do |task|
           puts "## Running after_start task: #{task}"
           Rake::Task[task].invoke
 

data/lib/minke/rake/config.rake

@@ -4,7 +4,7 @@ namespace :config do
   end
 
   task :set_docker_env do
-    DOCKER_IP = Minke::GoDocker.get_docker_ip_address
+    DOCKER_IP = Minke::Docker.get_docker_ip_address
     ENV['DOCKER_IP'] = DOCKER_IP
   end
 end

data/lib/minke/rake/docker.rake

@@ -1,16 +1,20 @@
 namespace :docker do
   desc "updates build images for swagger and golang will overwrite existing images"
   task :update_images do
+    config = Minke::Helpers.config
+
     puts "## Updating Docker images"
-  	Minke::GoDocker.pull_image 'golang:latest'
+  	Minke::Docker.pull_image config[:build_config][:docker][:image]
 
     puts ""
   end
 
   desc "pull images for golang from Docker registry if not already downloaded"
   task :fetch_images do
+    config = Minke::Helpers.config
+    
     puts "## Pulling Docker images"
-  	Minke::GoDocker.pull_image 'golang' unless Minke::GoDocker.find_image 'golang:latest'
+  	Minke::Docker.pull_image config[:build_config][:docker][:image] unless Minke::Docker.find_image config[:build_config][:docker][:image]
 
     puts ""
   end

data/lib/minke/version.rb

@@ -1,3 +1,3 @@
 module Minke
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/minke.rb

@@ -6,6 +6,9 @@ require 'rake'
 require "erb"
 
 require 'minke/version'
-require 'minke/go_docker'
+require 'minke/docker'
 require 'minke/docker_compose'
 require 'minke/helpers'
+
+require 'minke/commands/go'
+require 'minke/commands/swift'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minke
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Nic Jackson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,10 +127,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- examples/config.yml
+- examples/config_go.yml
+- examples/config_swift.yml
 - lib/minke.rb
+- lib/minke/commands/go.rb
+- lib/minke/commands/swift.rb
+- lib/minke/docker.rb
 - lib/minke/docker_compose.rb
-- lib/minke/go_docker.rb
 - lib/minke/helpers.rb
 - lib/minke/rake/app.rake
 - lib/minke/rake/config.rake