composify 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82d33d6cbdc717e2ae86615ec296753c3ec29045
+  data.tar.gz: 6fd8fb259a1b42d746f838c37ce8d57c3ff28b1d
+SHA512:
+  metadata.gz: 84a65c1fd5be49239ac99da8e100301441ea22bfab200b9a2141b412083028d87edabea12d81869129a3545c291a03beb6e8e08084bc8e6ac7bc65eaa2cbefc9
+  data.tar.gz: 13e77cb120ff322910200f77fe229cb61177a1a30a73b00553bd923fa12de68689b9e76a00ba9b93166292b76b24e8381bc09c3cef9738bb76900a96528d6e2b

data/README.md

@@ -0,0 +1,70 @@
+Sanely generate the infrastructure needed for developing a multi-component service in Docker.
+
+Generates the following tree:
+
+```
+<app root>
+├── Dockerfile.base
+├── Dockerfile.development # You'll install testing libraries and such in here.
+├── Makefile
+├── Makefile.internal
+├── bin
+│   ├── entrypoint.erb.sh
+│   └── make # In the Dockerfile, symlinked to /usr/local/bin/make
+└── docker-compose.yml
+```
+
+# Installation
+
+* ruby > 2.1 is required.
+* `gem install mocker`
+
+## Make Targets
+
+* `make` - initialize everything, shortcut for
+    - `pull`
+    - `images`
+    - `start_resources`
+    - `setup`
+    - `build`
+* `make pull` - Pull all image dependencies
+* `make images` - Build all images that need building
+* `make setup` - run any setup or seeding that is needed.
+* `make start` - start application containers
+* `make stop` - stop application containers
+* `make implode` - `docker-compose down --rmi all --volumes`
+* `make shell` - Run a shell container
+* `make production` - Build the non-development image
+* `make build` - An example for how to pass-through to the `Makefile.internal` (TODO)
+
+And, many more.  See the Makefile
+
+## Development Workflow
+
+### Initial
+
+```shell
+make && make up
+```
+
+### Code Iterations
+
+1. Make your code changes
+2. If using a compiled language, `make build` (or any pass-through target)
+3. `make run`, or `make up` depending on how you wish to see output.
+
+### Production (Non-Development) builds
+
+Building the production image is pretty easy.  Although, instead of thinking of it as a 'production' image, think of it instead as a `non-development` image.  Basically, your production image just doesn't have some of the development and testing tools installed.  Otherwise, it's the same.  You can see this because the Dockerfile chain is `Dockerfile.base -> Dockerfile.development`.  The "production" image just doesn't have the development image as layers on top of the base image.
+
+## Notes & Explainations
+
+* The main thing going on here is that your main services in the `docker-compose.yml` file have a bind-mounted source directory.
+* Once you run this project, all the generated files constitue the whole thing.  After initializing the project with `mocker init`, you do not need `mocker` any longer.  Nor do any team members ever need to install it.  You are free to modify and change anything that you want.
+
+## TODO
+
+1. Still need to work on the templates & generation if working on a compiled
+project such as go, c, rust, etc.
+2. Still need to add templates and such for projects like react that do live
+recompilation and inotify/fswatch types of things.

data/bin/composify

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'composify'
+
+Composify::CLI.main( ARGV )

data/composify.gemspec

@@ -0,0 +1,43 @@
+lib_path  = "./lib"
+spec_path = "./spec"
+bin_path  = "./bin"
+
+libs  = Dir.glob("#{lib_path}/**/*.rb")
+libs += Dir.glob("#{lib_path}/**/*.erb")
+
+specs = Dir.glob("#{spec_path}/**/*.rb")
+bins  = Dir.glob("#{bin_path}/**/*")
+
+flist = libs + specs + bins
+flist << "composify.gemspec"
+flist << "README.md"
+
+require_relative './lib/version'
+
+summary = <<-EOD
+A config generation library to generate a few Dockerfiles, Makefile, and
+docker-compose.yml file that will get everything setup for local docker
+development.  Specifically meant for use with non-trivial development setups.
+EOD
+
+Gem::Specification.new do |gem|
+  gem.name          = "composify"
+  gem.version       = Composify::VERSION
+  gem.authors       = ["Brett Nakashima"]
+  gem.email         = ["brettnak@gmail.com"]
+  gem.description   = "Docker development project generator"
+  gem.summary       = summary
+
+  # TODO: Rename this repo to match the gem name
+  gem.homepage      = "http://gitlab.com/brettnak/mocker"
+
+  gem.files         = flist
+  gem.executables   = bins.map{ |f| File.basename(f) }
+  gem.test_files    = specs
+  gem.require_paths = ["lib/"]
+
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'trollop', '~> 2.1'
+
+  gem.license = "MIT"
+end

data/lib/composify.rb

@@ -0,0 +1,107 @@
+require 'trollop'
+require 'erb'
+require 'fileutils'
+
+require_relative './version'
+
+module Composify
+  class Template
+    # TODO: Make these work on windows?
+    FILE_LIST = {
+      :entrypoint => './templates/bin/entrypoint.sh.erb',
+      :docker_compose => './templates/docker-compose.yml.erb',
+      :dockerfile_base => './templates/Dockerfile.erb',
+      :dockerfile_development => './templates/Dockerfile.development.erb',
+      :makefile => './templates/Makefile.erb',
+      # :makefile_internal => './templates/Makefile.internal.erb',
+    }
+
+    def initialize( file )
+      @file = file
+    end
+
+    def destination
+      return @_destination ||= @file.gsub( /^\.\/templates\//, './' ).gsub(/\.erb/, '')
+    end
+
+    # bind - the binding to use for ERB#result
+    def result( bind )
+      ERB.new(
+        File.read( File.expand_path( File.join("..", @file), __FILE__ ) ),
+        nil,
+        '-'
+      ).result( bind )
+    end
+
+    # bind - the binding to use for ERB#result
+    def write( bind, force: false )
+      if File.exists?( destination ) && !force
+        STDERR.puts( "File already exists at #{destination}.  Refusing to overwrite" )
+        return
+      end
+
+      if (dirname = File.dirname(destination)) != "."
+        FileUtils.mkdir_p( dirname )
+      end
+
+      puts "Attempting to write #{destination}"
+      File.open( destination, "w" ) do |f|
+        contents = result( bind )
+        f.write( contents )
+      end
+    end
+  end
+
+  class CLI
+    def self.main( argv )
+      cli = self.new( argv )
+      cli.generate
+    end
+
+    def self.from_trollop( argv )
+      opts = Trollop::options(argv) do
+        version "mocker #{Composify::VERSION}"
+        banner "Generate a docker-development environment.\nNOTE: The name of your project is the directory"
+        opt :base, "Base image of your application", :type => :string, :required => true
+        opt :compilable, "Does your application code needs to be compiled?", :type => :bool, :default => false, :short => "C"
+        opt :components, "The names of your application services, ie: api, scheduler, etc.", :type => :strings, :required => true
+        opt :resource, "[ resource_name, resource_image ] The resources you will use.  May be specified more than once.", :type => :strings, :multi => true
+        opt :force, "Overwrite any files that exist", :type => :bool, :default => false
+      end
+
+      opts[:resources] = opts[:resource].map{ |e| parse_resource(e) }
+
+      opts[:root] = Dir.pwd
+      opts[:project_name] = File.basename( Dir.pwd ).gsub(/[^a-zA-Z0-9_]/, '')
+
+      return opts
+    end
+
+    # definition is an array like this:
+    # [ resource_name, image ]
+    # Returns: [{ :name => "<resource_name>", :image => "<image_url>" }, ... ]
+    def self.parse_resource( definition )
+      return {
+        :name  => definition[0],
+        :image => definition[1]
+      }
+    end
+
+    def initialize( argv )
+      @argv = ARGV
+    end
+
+    def options
+      return @_options ||= self.class.from_trollop( @argv )
+    end
+
+    def generate
+      b = binding
+      Template::FILE_LIST.each_pair do |_, file|
+        template = Template.new( file )
+        template.write( b, force: options[:force] )
+      end
+    end
+  end
+
+end

data/lib/templates/Dockerfile.development.erb

@@ -0,0 +1,8 @@
+FROM        <%= options[:project_name] %>_base:latest
+
+# This is where you'd install stuff like test libraries
+# Or, for a ruby project, where you'd install the bundle with everything
+# rather than just the production stuff
+
+# Do not put ENTRYPOINT or CMD in here.  Instead, let them be inherited from the
+# Dockerfile.base

data/lib/templates/Dockerfile.erb

@@ -0,0 +1,18 @@
+FROM       <%= options[:base] %>
+
+# Depending on the docker image you're using, you may need to specify a
+# different workdir, or even not set one and use the perscribed one from the
+# base image.  If you do change it, don't forget to change where the
+# bind-mounting happens in the compose file.
+<%- workdir = "/src" %>
+
+RUN        mkdir -p <%= workdir %>
+
+WORKDIR    <%= workdir %>
+
+ADD        . <%= workdir %>
+
+# Do any other initializations steps here.
+
+ENTRYPOINT [ <%= workdir %>/bin/entrypoint.sh ]
+CMD        [ "pass" ]

data/lib/templates/Makefile.erb

@@ -0,0 +1,71 @@
+DOCKER               ?= docker
+DOCKER_COMPOSE       ?= docker-compose
+APPLICATION_SERVICES  = <%= options[:components].join(" ") %>
+RESOURCE_SERVICES     = <%= options[:resources].map{ |e| e[:name] }.join(" ") %>
+COMPOSE_SHELL         = ${DOCKER_COMPOSE} run --rm shell
+
+default_target: initialize
+
+initialize:
+	$(MAKE) images
+	$(MAKE) start
+	$(MAKE) setup
+	@echo "Everything initialized and started."
+
+images: pull
+	@echo "Building base && base_development"
+	@${DOCKER_COMPOSE} build base
+	@${DOCKER_COMPOSE} build base_development
+	@echo "Images are prepped. Run 'make start' to set things up"
+
+pull:
+	@echo "Pulling all images"
+	# pull --ignore-pull-failures has been broken since compose 1.13
+	# https://github.com/docker/compose/issues/4377
+	# @${DOCKER_COMPOSE} pull --ignore-pull-failures
+	#
+	# For now, we have to manage this explicitely...
+	@${DOCKER_COMPOSE} pull base_external ${RESOURCE_SERVICES}
+
+setup:
+	@${COMPOSE_SHELL} setup
+
+run: start-resources
+	@${DOCKER_COMPOSE} up ${APPLICATION_SERVICES}
+
+start:
+	@${DOCKER_COMPOSE} up -d ${RESOURCE_SERVICES} ${APPLICATION_SERVICES}
+
+# Send a sigterm before compose stop to get them just to shut down.
+# Remove that if you want more graceful shutdowns of the application.
+stop:
+	@${DOCKER_COMPOSE} kill -s SIGTERM ${APPLICATION_SERVICES}
+	@${DOCKER_COMPOSE} stop ${APPLICATION_SERVICES}
+
+start-resources:
+	@if [ ! -z ${RESOURCE_SERVICES} ] ; then ${DOCKER_COMPOSE} up -d ${RESOURCE_SERVICES}; fi
+
+stop-resources:
+	@${DOCKER_COMPOSE} stop
+
+shell:
+	@${COMPOSE_SHELL}
+
+test:
+	 @${COMPOSE_SHELL} "test"
+
+implode:
+	@${DOCKER_COMPOSE} down --volumes --rmi all
+
+# Delete the application containers
+rm-application:
+	@${DOCKER_COMPOSE} rm -f ${APPLICATION_SERVICES}
+
+production:
+	@${DOCKER_COMPOSE} build base
+	@echo "Your image is ready and tagged as <%= options[:project_name] %>_base:latest"
+
+reset:
+	@echo "Fully resetting the environment"
+	$(MAKE) implode
+	$(MAKE) initialize

data/lib/templates/bin/entrypoint.sh.erb

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+set -e
+
+cmd=$1; shift
+
+case "$cmd" in
+  shell)
+    exec "/bin/bash"
+    ;;
+  console)
+    # If your environment can have a console, put that target here.
+    echo "No console configured for <%= options[:project_name] %>"
+    exit 0
+    ;;
+  pass)
+    echo "Containter starts."
+    exit 0
+    ;;
+  cmd)
+    echo "$@"
+    exec /bin/bash -c "$*"
+    ;;
+  setup)
+    echo "This environment has no setup steps"
+    exit 0
+    ;;
+  <%- options[:components].each do |component| -%>
+  <%= component %>)
+    # Put this components start command here.
+    echo "No start command for <%= component %>"
+    exit 0
+    ;;
+  <%- end -%>
+  *)
+    echo "Please pass a valid command.  You passed '$cmd', which is invald."
+    exit 3
+esac

data/lib/templates/docker-compose.yml.erb

@@ -0,0 +1,59 @@
+---
+version: '2'
+<%- development_image = "#{options[:project_name]}_base_development:latest" -%>
+
+services:
+  base_external:
+    image: <%= options[:base] %>
+
+  base:
+    build:
+      dockerfile: Dockerfile
+      context: ./
+    command:
+      - pass
+
+  base_development:
+    build:
+      dockerfile: Dockerfile.development
+      context: ./
+    command:
+      - pass
+
+  shell:
+    image: <%= development_image %>
+    command:
+      - shell
+    volumes: &std_volumes
+      - ".:/src"
+    <%- unless options[:resources].empty? -%>
+    depends_on: &std_depends
+      <%- options[:resources].each do |resource| -%>
+      - <%= resource[:name] %>
+      <%- end -%>
+    <%- end -%>
+
+  <%- options[:components].each do |component| -%>
+  <%= component %>:
+    image: <%= development_image %>
+    command:
+      - <%= component %>
+      # You may want additional arguments here.
+    volumes: *std_volumes
+    <%- unless options[:resources].empty? -%>
+    depends_on: *std_depends
+    <%- end -%>
+  <%- end -%>
+
+  <%- unless options[:resources].empty? -%>
+  # You'll almost certanily need to heavily modify any external resource images
+  # that you use.
+  <%- end -%>
+  <%- options[:resources].each do |resource| -%>
+  <%= resource[:name] %>:
+    image: <%= resource[:image] %>
+    # volumes:
+    #   - Do you need to mount a config dir?
+    # ports:
+    #   - Do you need to expose any ports to the host?
+  <%- end -%>

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Composify
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: composify
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Brett Nakashima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Docker development project generator
+email:
+- brettnak@gmail.com
+executables:
+- composify
+extensions: []
+extra_rdoc_files: []
+files:
+- "./bin/composify"
+- "./lib/composify.rb"
+- "./lib/templates/Dockerfile.development.erb"
+- "./lib/templates/Dockerfile.erb"
+- "./lib/templates/Makefile.erb"
+- "./lib/templates/Makefile.internal.erb"
+- "./lib/templates/bin/entrypoint.sh.erb"
+- "./lib/templates/docker-compose.yml.erb"
+- "./lib/version.rb"
+- README.md
+- bin/composify
+- composify.gemspec
+homepage: http://gitlab.com/brettnak/mocker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A config generation library to generate a few Dockerfiles, Makefile, and
+  docker-compose.yml file that will get everything setup for local docker development.  Specifically
+  meant for use with non-trivial development setups.
+test_files: []