stack_car 0.6.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c211b3d1c2030db2a5e70cb4bf82e735d161ff30
-  data.tar.gz: 2d66451f16f94290bdc5cc85af8ed13893f1acde
+SHA256:
+  metadata.gz: 0e8df8e8dbd70e738de0a61cd09489c72e4cd822326b237269d21ebe4dacd258
+  data.tar.gz: 11214bdf66ad316ad4feec518f0ef0e39f9e146aea500c3b7e187a67ecaa33fe
 SHA512:
-  metadata.gz: 7e7deb0336394994473ee04230589480b72fb43983cf6bba5bf741475deb8f7c574b0584feba769b28fff08cd3d356095357013541cc37977f300b38aef5b2da
-  data.tar.gz: 21a74ff7c055eab71c3a4c43f260830756b2adfe72f23ff3d335788384d3575587b59fb72e490ddfe4c1f1cef5a448062f3a5aea4bb321d98fbd653e55b12eea
+  metadata.gz: 65b81508cd79dd4fdff903820133034b4dc894eeaff69a3033e2439b9cae81f5b34e48055a83485e56f3236ea7111cc9dc24d3c8a3a8cdb8341a5b64490e070a
+  data.tar.gz: 60223a2ce56c3173e4c62b8d08e05e1d8c6c5fcd2c64027864cef6aa76857c88e3b9a9ae2d6c88cd4a229f2c858f1f1359959b849faffe129119258500b97b2c

data/README.md

@@ -33,7 +33,70 @@ Commands:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**To install this gem onto your local machine**
+- Run `bundle exec rake install`
+
+### Workflow
+
+**Create a dummy rails app**
+
+Developing stack_car often requires a rails application for you to run updated commands and templates against. Generate one for this purpose:
+- `rails new <dummy-app-name>`
+
+**Make and test your changes**
+- In stack_car, make your command / template changes
+- Run `rake install` to update your local gem
+- In your dummy application, test the updated command
+- Commit your changes
+
+### Releasing a new version
+- Update the version number in `version.rb`
+- Run `bundle exec rake release`
+  - This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Generating a Helm Chart
+
+stack_car's **dockerize** command can be used in conjunction with available flags to generate a **Helm chart** template for your application. You will need to create the *values* files with necessary configuration values from the *sample-values* provided by stack_car, but the command will effectively give you the baseline Notch8 template (scripts, template files, template helpers, sample values file) for a **Helm base Kubernetes deploy**
+
+The following examples are to be run in the repo of the application you are creating the chart for.
+
+**To generate a Helm chart template**
+
+- `sc dockerize --helm`
+  - This command without additional flags will only generate Rails web related template files
+
+In broad strokes adding additional flags signals stack_car to generate template files for other services. Note that any configuration that would normally be applied for these services in a non Helm context (without the `--helm` flag) still apply.
+
+**For example**:
+- `sc dockerize --helm --fcrepo --solr`
+  - This command will add templates for the **fcrepo** service and add a **solr chart dependency** in the `Chart.yaml` (You can think of `Chart.yaml` like the **Gemfile** or **package.json** of a Helm chart)
+
+**Creating values files**
+
+Values files allows you to configure your helm deploy from number of web instances to hostname for your ingress to environment variables required by your application.
+
+When starting from a new helm chart, you'll want to copy the sample values file to one named after the environment you're creating a deployment for.
+
+For example:
+`cp sample-values.yaml staging-values.yaml`
+
+*Note: You will do this once for every environment you'd like to deploy*
+
+**Handling values files**
+
+Since values files are likely to contain sensitive information like API keys, they should never be committed to your repository. The scripts that stack_car includes in your chart simplifies encrypting and decrypting values for version control.
+
+Example workflow (given values file is already created):
+- Edit values file
+- `chart/bin/encrypt staging <keybase-team-name>`
+  - This command will create `staging-values.yaml.enc`
+- `git add staging-values.yaml.enc`
+- Commit and push
+
+When pulling down a repo or branch, you will need to start by decrypting.
+
+Example:
+- `chart/bin/decrypt staging`
 
 ## Contributing
 

data/lib/stack_car.rb

@@ -1,5 +1,6 @@
 require "stack_car/version"
 require "stack_car/cli"
+require "stack_car/dot_rc"
 
 module StackCar
   # Your code goes here...

data/lib/stack_car/cli.rb

@@ -1,7 +1,8 @@
 require 'thor'
 require 'erb'
 require 'dotenv/load'
-
+require 'json'
+require 'byebug'
 module StackCar
   class HammerOfTheGods < Thor
     include Thor::Actions
@@ -19,111 +20,135 @@ module StackCar
     method_option :logs, default: true, type: :boolean
     desc "up", "starts docker-compose with rebuild and orphan removal, defaults to web"
     def up
+      setup
+      ensure_development_env
       args = ['--remove-orphans']
       args << '--build' if options[:build]
       if options[:build]
-        run("docker-compose pull #{options[:service]}")
+        run("#{dotenv} docker-compose pull #{options[:service]}")
       end
 
-      run("docker-compose up #{args.join(' ')} #{options[:service]}")
+      run_with_exit("#{dotenv} docker-compose up #{args.join(' ')} #{options[:service]}")
     end
 
     method_option :service, default: '', type: :string, aliases: '-s'
     desc "stop", "stops the specified running service, defaults to all"
     def stop
-      run("docker-compose stop #{options[:service]}")
-      run("rm -rf tmp/pids/*")
+      setup
+      ensure_development_env
+      run("#{dotenv} docker-compose stop #{options[:service]}")
+      run_with_exit("rm -rf tmp/pids/*")
     end
     map down: :stop
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "build", "builds specified service, defaults to web"
     def build
-      run("docker-compose build #{options[:service]}")
+      setup
+      ensure_development_env
+      run_with_exit("#{dotenv} docker-compose build #{options[:service]}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "push ARGS", "wraps docker-compose push web unless --service is used to specify"
     def push(*args)
-      run("docker-compose push #{options[:service]} #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose push #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "pull ARGS", "wraps docker-compose pull web unless --service is used to specify"
     def pull(*args)
-      run("docker-compose pull #{options[:service]} #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose pull #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: '', type: :string, aliases: '-s'
     desc "ps ARGS", "wraps docker-compose pull web unless --service is used to specify"
     def ps(*args)
-      run("docker-compose ps #{options[:service]} #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose ps #{options[:service]} #{args.join(' ')}")
     end
     map status: :ps
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "bundle ARGS", "wraps docker-compose run web unless --service is used to specify"
     def bundle(*args)
-      run("docker-compose exec #{options[:service]} bundle")
+      setup
+      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "walk ARGS", "wraps docker-compose run web unless --service is used to specify"
     def walk(*args)
-      run("docker-compose run #{options[:service]} #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose run #{options[:service]} #{args.join(' ')}")
     end
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "exec ARGS", "wraps docker-compose exec web unless --service is used to specify"
     def exec(*args)
-      run("docker-compose exec #{options[:service]} #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} #{args.join(' ')}")
     end
     map ex: :exec
 
+    method_option :service, default: 'web', type: :string, aliases: '-s'
+    desc 'sh ARGS', "launch a shell using docker-compose exec, sets tty properly"
+    def sh(*args)
+      setup
+      run_with_exit("#{dotenv} docker-compose exec -e COLUMNS=\"\`tput cols\`\" -e LINES=\"\`tput lines\`\" #{options[:service]} bash #{args.join(' ')}")
+    end
+
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "bundle_exec ARGS", "wraps docker-compose exec web bundle exec unless --service is used to specify"
     def bundle_exec(*args)
-      run("docker-compose exec #{options[:service]} bundle exec #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle exec #{args.join(' ')}")
     end
     map be: :bundle_exec
 
     method_option :service, default: 'web', type: :string, aliases: '-s'
     desc "console ARGS", "shortcut to start rails console"
     def console(*args)
-      run("docker-compose exec #{options[:service]} bundle exec rails console #{args.join(' ')}")
+      setup
+      run_with_exit("#{dotenv} docker-compose exec #{options[:service]} bundle exec rails console #{args.join(' ')}")
     end
     map rc: :console
 
     desc "release ENVIRONTMENT", "tag and push and image to the registry"
     def release(environment)
+      setup
       timestamp = Time.now.strftime("%Y%m%d%I%M%S")
-      sha = `git rev-parse HEAD`[0..7]
+      sha = `git rev-parse HEAD`[0..8]
       registry = "#{ENV['REGISTRY_HOST']}#{ENV['REGISTRY_URI']}"
       tag = ENV["TAG"] || 'latest'
       unless File.exists?("#{ENV['HOME']}/.docker/config.json") && File.readlines("#{ENV['HOME']}/.docker/config.json").grep(/#{ENV['REGISTRY_HOST']}/).size > 0
-        run("docker login #{ENV['REGISTRY_HOST']}")
+        run_with_exit("#{dotenv(environment)} docker login #{ENV['REGISTRY_HOST']}")
       end
-      run("docker tag #{registry}:#{tag} #{registry}:#{environment}-#{timestamp}")
-      run("docker push #{registry}:#{environment}-#{timestamp}")
-      run("docker tag #{registry}:#{tag} #{registry}:#{sha}")
-      run("docker push #{registry}:#{sha}")
-      run("docker tag #{registry}:#{tag} #{registry}:#{environment}-latest")
-      run("docker push #{registry}:#{environment}-latest")
-      run("docker tag #{registry}:#{tag} #{registry}:latest")
-      run("docker push #{registry}:latest")
+      run_with_exit("#{dotenv(environment)} docker tag #{registry}:#{tag} #{registry}:#{environment}-#{timestamp}")
+      run_with_exit("#{dotenv(environment)} docker push #{registry}:#{environment}-#{timestamp}")
+      run_with_exit("#{dotenv(environment)} docker tag #{registry}:#{tag} #{registry}:#{sha}")
+      run_with_exit("#{dotenv(environment)} docker push #{registry}:#{sha}")
+      run_with_exit("#{dotenv(environment)} docker tag #{registry}:#{tag} #{registry}:#{environment}-latest")
+      run_with_exit("#{dotenv(environment)} docker push #{registry}:#{environment}-latest")
+      run_with_exit("#{dotenv(environment)} docker tag #{registry}:#{tag} #{registry}:latest")
+      run_with_exit("#{dotenv(environment)} docker push #{registry}:latest")
     end
 
     desc "provision ENVIRONMENT", "configure the servers for docker and then deploy an image"
     def provision(environment)
+      setup
       # TODO make dotenv load a specific environment?
-      run("dotenv ansible-playbook -i ops/hosts -l #{environment}:localhost ops/provision.yml")
+      run_with_exit("DEPLOY_ENV=#{environment} #{dotenv(environment)} ansible-playbook -i ops/hosts -l #{environment}:localhost ops/provision.yml")
     end
 
     desc "ssh ENVIRONMENT", "log in to a running instance - requires PRODUCTION_SSH to be set"
     def ssh(environment)
+      setup
       target = ENV["#{environment.upcase}_SSH"]
       if target
-        run(target)
+        run_with_exit(target)
       else
         say "Please set #{environment.upcase}_SSH"
       end
@@ -131,22 +156,27 @@ module StackCar
 
     desc "deploy ENVIRONMENT", "deploy an image from the registry"
     def deploy(environment)
-      run("dotenv ansible-playbook -i ops/hosts -l #{environment}:localhost ops/deploy.yml")
+      setup
+      run_with_exit("DEPLOY_HOOK=$DEPLOY_HOOK_#{environment.upcase} #{dotenv(environment)} ansible-playbook -i ops/hosts -l #{environment}:localhost ops/deploy.yml")
     end
 
-    method_option :elasticsearch, default: false, type: :boolean, aliases: '-e'
-    method_option :solr, default: false, type: :boolean, aliases: '-s'
-    method_option :postgres, default: false, type: :boolean, aliases: '-p'
-    method_option :mysql, default: false, type: :boolean, aliases: '-m'
-    method_option :redis, default: false, type: :boolean, aliases: '-r'
     method_option :delayed_job, default: false, type: :boolean, aliases: '-j'
-    method_option :fcrepo, default: false, type: :boolean, aliases: '-f'
     method_option :deploy, default: false, type: :boolean, aliases: '-d'
+    method_option :elasticsearch, default: false, type: :boolean, aliases: '-e'
+    method_option :fcrepo, default: false, type: :boolean, aliases: '-f'
+    method_option :helm, default: false, type: :boolean, aliases: '-h'
+    method_option :git, default: true, type: :boolean, aliases: '-g'
     method_option :heroku, default: false, type: :boolean, aliases: '-h'
+    method_option :hyku, default: false, type: :boolean, aliases: '-u'
+    method_option :imagemagick, default: false, type: :boolean, aliases: '-i'
+    method_option :memcached, default: false, type: :boolean, aliases: '-mc'
+    method_option :mongodb, default: false, type: :boolean, aliases: '-mg'
+    method_option :mysql, default: false, type: :boolean, aliases: '-m'
+    method_option :postgres, default: false, type: :boolean, aliases: '-p'
     method_option :rancher, default: false, type: :boolean, aliases: '-dr'
+    method_option :redis, default: false, type: :boolean, aliases: '-r'
     method_option :sidekiq, default: false, type: :boolean, aliases: '-sq' # TODO
-    method_option :mongodb, default: false, type: :boolean, aliases: '-mg'
-    method_option :memcached, default: false, type: :boolean, aliases: '-mc'
+    method_option :solr, default: false, type: :boolean, aliases: '-s'
     method_option :yarn, default: false, type: :boolean, aliases: '-y'
     desc 'dockerize DIR', 'Will copy the docker tempates in to your project, see options for supported dependencies'
     long_desc <<-DOCKERIZE
@@ -157,9 +187,14 @@ module StackCar
     DOCKERIZE
     def dockerize(dir=".")
       Dir.chdir(dir)
+      self.destination_root = dir
+      setup
+      # Commandline overrides config files
+      # options = file_config.merge(options)
       @project_name = File.basename(File.expand_path(dir))
       apt_packages << "libpq-dev postgresql-client" if options[:postgres]
       apt_packages << "mysql-client" if options[:mysql]
+      apt_packages << "imagemagick" if options[:imagemagick]
       pre_apt << "echo 'Downloading Packages'"
       post_apt << "echo 'Packages Downloaded'"
 
@@ -179,7 +214,7 @@ module StackCar
         post_apt << "cd /opt && unzip fits-1.0.5.zip && chmod +X fits-1.0.5/fits.sh"
       end
 
-     ['.dockerignore', 'Dockerfile', 'Dockerfile.base', 'docker-compose.yml', 'docker-compose.ci.yml', 'docker-compose.production.yml', '.gitlab-ci.yml', '.env'].each do |template_file|
+     ['.dockerignore', 'Dockerfile', 'Dockerfile.base', 'docker-compose.yml', '.gitlab-ci.yml', '.env'].each do |template_file|
        puts template_file
         template("#{template_file}.erb", template_file)
      end
@@ -196,14 +231,33 @@ module StackCar
          File.read("#{self.class.source_root}/README.md")
        end
      end
-     append_to_file("Gemfile", "gem 'activerecord-nulldb-adapter'")
+
+      if File.exist?('Gemfile')
+        append_to_file('Gemfile', "gem 'activerecord-nulldb-adapter'")
+      else
+        append_to_file('../Gemfile', "gem 'activerecord-nulldb-adapter'", { verbose: false })
+        # TODO: remove '../' from message after other status messages are prepended with 'stack_car/'
+       append_to_file("../Gemfile", "gem 'pronto', groups: [:development, :test]")
+       append_to_file("../Gemfile", "gem 'pronto-rubocop', groups: [:development, :test]")
+        say_status(:append, '../Gemfile')
+      end
+
       if options[:deploy] || options[:rancher]
         directory('ops')
         ['hosts', 'deploy.yml', 'provision.yml'].each do |template_file|
           template("#{template_file}.erb", "ops/#{template_file}")
         end
+
         say 'Please update ops/hosts with the correct server addresses'
-      else
+      elsif options[:helm]
+        directory('chart')
+        if options[:fcrepo]
+          directory('chart-fcrepo', 'chart/templates')
+        end
+        if options[:sidekiq]
+          directory('chart-sidekiq', 'chart/templates')
+        end
+     else
         empty_directory('ops')
       end
 
@@ -251,5 +305,49 @@ module StackCar
       post_apt.join(" && \\\n")
     end
 
+    def run_with_exit(*args)
+      result = run(*args)
+      if !result
+        exit(1)
+      end
+    end
+
+    def file_config
+      path = find_config(Dir.pwd)
+      if path
+        JSON.parse(File.read(path))
+      else
+        {}
+      end
+    end
+
+    def find_config(dir)
+      path = File.join(dir, '.stackcar_rc')
+      if File.exists?(path)
+        return path
+      elsif dir == "/"
+        return nil
+      else
+        return find_config(File.dirname(dir))
+      end
+    end
+
+    def ensure_development_env
+      if !File.exists?('.env.development')
+        template(".env.development.erb", ".env.development")
+      end
+    end
+
+    def dotenv(environment='development')
+      "dotenv -f .env.#{environment},.env"
+    end
+
+    def setup
+      if File.exists?('stack_car')
+        Dir.chdir('stack_car')
+        self.destination_root += "/stack_car"
+      end
+      DotRc.new
+    end
   end
 end

data/lib/stack_car/dot_rc.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'pathname'
+module StackCar
+  class DotRc
+    include Thor::Shell
+
+    def initialize
+      @file = find_file
+      say_status :load, 'not found', :red && return unless @file
+      say_status :load, @file
+      load(@file)
+    end
+
+    def find_file
+      path = nil
+      Pathname(Dir.pwd).ascend do |p|
+        if File.directory?(p) && File.exist?(File.join(p, '.stack_car_rc'))
+          path = File.join(p, '.stack_car_rc')
+          break
+        end
+      end
+      path
+    end
+  end
+end

data/lib/stack_car/version.rb

@@ -1,3 +1,3 @@
 module StackCar
-  VERSION = "0.6.1"
+  VERSION = "0.12.0"
 end

data/stack_car.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard-thor"
   spec.add_development_dependency "pry"
   spec.add_runtime_dependency "dotenv", "~> 2.2"
+  spec.add_runtime_dependency "json", "~> 2.3"
   spec.add_runtime_dependency "thor", "~> 0.19"
 end