kaiser 0.4.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b038487b21d1842c497c567c1b7f5bfcd15113f4099106f3de2d59fbbd1151c9
-  data.tar.gz: 7177b78736ccef59a0b4f4c0d2cfd0902cb4db1f5c235e9ed9eb8e6424ff6039
+  metadata.gz: 6923e91422d9639f4a595188c2cecc59e76634d01d738113caa52b877bd65ed7
+  data.tar.gz: 8014fb2b25df573937ed6529d068bc3b4d8aee0c1079703d7ecea871088e2df2
 SHA512:
-  metadata.gz: deeb309b718a0bc5a53c108da2e561096deaa05fbf49433c6253c38b40435283e8dc53ac6bd122fe6726176f94e2f5823476805ddc50ba37a6c1b46ef9b3d8fb
-  data.tar.gz: b9b5a6bd7ee1e163bbb1ff1ea00fb7112efa47bf8ddb7f5ba1a5c4f9a456cfb5b7475da68bfcbc15889774392b1b7b1c6044ca7ca6f48430b30a2dfe863e0f95
+  metadata.gz: 6cd4c933744c44dca6dcb34f0f17e7379f7776e7a12d277606fe71fb213ad456fbd32357c777e58b61cb4928e3fcff0a815c7efbfd99e2162bdd9c1fdc1202ad
+  data.tar.gz: 056070423d8763378e279765c5d91dd9668c82600372e76fc8ed417baef0d834d38fd60f10c66d45f16a01395034497b210a03300b7d990bc413d32ce77aca49

data/README.md

@@ -97,6 +97,95 @@ open http://myapp.lvh.me
 
 And enjoy previewing your app!
 
+#### Anatomy of a Kaiserfile
+
+A Kaiserfile is made up of statements, which are different commands followed by some parameters. Each command is just a ruby method so you can call it that way. Only the `dockerfile` command is required. All the other commands are either not required or have defaults.
+
+- `plugin` - Takes 1 parameter: the name of the plugin you wish to use in this Kaiserfile.
+
+```ruby
+# Example
+plugin :git_submodule
+```
+
+See further below to find available plugins and their usage
+
+- `dockerfile` - This command is always required. Takes 1 parameter: the name of the Dockerfile you want to use with this Kaiserfile. You only need to use this command once. Using it multiple times will simply cause the last command to be used. It takes relative paths and the paths are relative to where you run Kaiser.
+
+```ruby
+# Example
+dockerfile 'Dockerfile'
+```
+
+- `service` - This command is optional. Use it to define additional containers that should be set up along with your environment,. You can use it multiple times to define multiple services. It takes multiple parameters, a name parameter which is required and optional parameters.
+
+```ruby
+# example that sets up a redis server for your app
+service 'redis'
+```
+
+The following parameters are allowed for this command:
+- image
+
+```ruby
+# example that tells it to use the redis server with the alpine tag from 'myrepo'
+service 'redis', image: 'myrepo/redis:alpine'
+```
+
+- `attach_mount` - Takes 2 parameters: The first parameter is the relative path of a folder or a file outside the container and the second parameter is its absolute path inside the container. This is only used when `kaiser attach` or `kaiser up -a` is used. This will mount the file or folder inside the container and sync their contents. If the file you specified does not exist, Kaiser will create a folder where you specify it and then mount that folder inside the container. You can specify as many of these as you want.
+
+```ruby
+# Example to mount the `app` directory into the container's `/srv/files/app`
+attach_mount 'app', '/srv/files/app'
+```
+
+- `expose` - Takes 1 parameter: The port of the server running inside the container. This port is not exposed on the host, so it will not occupy a port on the computer you run kaiser on. Instead, Kaiser will select a random port on the host computer to forward traffic to and from. You can only use this statement once. If you have multiple of these statements the last one will be used.
+
+```ruby
+# Example to expose the port 3636
+expose 3636
+```
+
+- `app_params` - Takes 1 parameter: A string of parameters to the `docker run` command to add custom environment variables with. Please refer to the docker documentation to see what kinds of parameters you can pass to the `docker run` command. By default this is just an empty string. You can only pass one of these. Any newline characters in the string will be converted into spaces.
+
+```ruby
+# Example
+app_params '-e INTERACTIVE=no'
+```
+
+- `type` - Takes 1 parameter: Right now the only parameter it can take is `:http`. If this parameter is specified, kaiser will poll the application until it receives a 200 status code before it closes when you use `kaiser up` If it doesn't it will close with a status code of 1.
+
+```ruby
+# Example
+type :http
+```
+
+- `db_reset_command` - Takes 1 parameter: A command to reset the database. This command is optional. By default this parameter is `echo "no db to reset"`. You can only specify one of these. If you have multiple of these commands only the last one will be used.
+
+```ruby
+# Example if running this command drops the db and recreates it.
+db_reset_command 'rake db:reset'
+```
+
+- `db` - Takes 1 parameter in the form of a hash. The default value of the hash is as follows:
+
+(You do not have to use this strictly, see the Database Plugin below to see an easier way to include MySQL and Postgres in your environment)
+
+```ruby
+# Default settings
+{
+  image: 'alpine',
+  port: 1234,
+  data_dir: '/tmp/data',
+  params: '',
+  commands: 'echo "no db"',
+  waitscript: 'echo "no dbwait"',
+  waitscript_params: ''
+}
+```
+
+You can use this to customize the database that you wish to use with your server.
+
 ### Alternative Kaiserfile
 
 If you want change your dev environment for a project, but don't want to overwrite the project's Kaiserfile/Dockerfile,
@@ -258,6 +347,59 @@ kaiser up
 
 Again for changes to take effect.
 
+## Plugins
+
+Kaiser has a plugin system that adds commands to the Kaiserfile to help improve your workflow. Below are a list of built-in plugins that come with Kaiser.
+
+### Git Submodules Plugin
+
+This plugin ensures that any submodules your repo has are checked out. If they are not, it will cause Kaiser to exit with a status code of 1.
+
+Usage:
+
+```ruby
+plugin :git_submodule
+```
+
+That's all you need!
+
+### Database Plugin
+
+This plugin allows you to specify well known DBs (MySQL and PostgresSQL) with default values that work generally. You can customize your database however you want it for your own project.
+
+Usage:
+
+```ruby
+# Simplest usage
+plugin :database
+
+def_db :mysql
+```
+
+If for example you wish to use a different root password, simply go
+
+```ruby
+plugin :database
+
+def_db mysql: { root_password: 'extremesecret' }
+```
+
+Sometimes you want to use a specific version for testing. You can set up the version by going
+
+```ruby
+plugin :database
+
+def_db postgres: { version: '9.4' }
+```
+
+You can also pass startup parameters to your database server:
+
+```ruby
+plugin :database
+
+def_db mysql: { parameters: '--verbose' }
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
@@ -275,7 +417,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Kaiser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/degica/kaiser/blob/master/CODE_OF_CONDUCT.md).
-
-## Contributors
-
-- Guga Katsiashvili (provided the rubygem)

data/lib/kaiser.rb

@@ -27,7 +27,8 @@ require 'kaiser/cmds/set'
 require 'kaiser/cmds/root'
 
 require 'kaiser/plugin'
-require 'kaiser/plugins/git_submodule'
+
+require 'kaiser/service'
 
 # Kaiser
 module Kaiser

data/lib/kaiser/cli.rb

@@ -17,6 +17,8 @@ module Kaiser
       @config = Config.config
       @out = Config.out
       @info_out = Config.info_out
+
+      @kaiserfile.validate!
     end
 
     # At first I did this in the constructor but the problem with that is Optimist
@@ -91,15 +93,30 @@ module Kaiser
       output
     end
 
-    def down
-      stop_db
-      stop_app
-      delete_db_volume
-    end
-
     def stop_app
       Config.info_out.puts 'Stopping application'
       killrm app_container_name
+      stop_services
+    end
+
+    def start_services
+      services.each do |service|
+        Config.info_out.puts "Starting service: #{service.name}"
+        run_if_dead(
+          service.shared_name,
+          "docker run -d
+            --name #{service.shared_name}
+            --network #{Config.config[:networkname]}
+            #{service.image}"
+        )
+      end
+    end
+
+    def stop_services
+      services.each do |service|
+        Config.info_out.puts "Stopping service: #{service.name}"
+        killrm service.shared_name
+      end
     end
 
     private
@@ -236,6 +253,8 @@ module Kaiser
     end
 
     def start_app
+      start_services
+
       Config.info_out.puts 'Starting up application'
       killrm app_container_name
       CommandRunner.run! Config.out, "docker run -d
@@ -351,6 +370,10 @@ module Kaiser
       Config.config[:networkname]
     end
 
+    def services
+      @services ||= Config.kaiserfile.services.map { |name, info| Service.new(envname, name, info) }
+    end
+
     def db_port
       Config.config[:envs][envname][:db_port]
     end

data/lib/kaiser/cmds/down.rb

@@ -12,7 +12,9 @@ module Kaiser
       end
 
       def execute(_opts)
-        down
+        stop_db
+        stop_app
+        delete_db_volume
       end
     end
   end

data/lib/kaiser/databases/mysql.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module Databases
+    class Mysql
+      def initialize(options)
+        @options = options
+      end
+
+      def options_hash
+        testpass = @options[:root_password] || 'testpassword'
+        parameters = @options[:parameters] || ''
+        port = @options[:port] || 3306
+
+        {
+          port: port,
+          data_dir: '/var/lib/mysql',
+          params: "-e MYSQL_ROOT_PASSWORD=#{testpass}",
+          commands: parameters,
+          waitscript_params: "
+            -e MYSQL_ADDR=<%= db_container_name %>
+            -e MYSQL_PORT=#{port}
+            -e MYSQL_ROOT_PASSWORD=#{testpass}",
+          waitscript: <<~SCRIPT
+            #!/bin/bash
+
+            echo "Waiting for mysql to start."
+            until mysql -h"$MYSQL_ADDR" -P"$MYSQL_PORT" -uroot -p"$MYSQL_ROOT_PASSWORD" -e "SELECT 1"
+            do
+              printf "."
+              sleep 1
+            done
+
+            echo -e "\nmysql started."
+          SCRIPT
+        }
+      end
+
+      def image_name
+        version = @options[:version] || '5.6'
+        "mysql:#{version}"
+      end
+    end
+  end
+end

data/lib/kaiser/databases/postgres.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Kaiser
+  module Databases
+    class Postgres
+      def initialize(options)
+        @options = options
+      end
+
+      def options_hash
+        testpass = @options[:root_password] || 'testpassword'
+        parameters = @options[:parameters] || ''
+        port = @options[:port] || 3306
+
+        {
+          port: port,
+          data_dir: '/var/lib/postgresql/data',
+          params: "-e POSTGRES_PASSWORD=#{testpass}",
+          commands: parameters,
+          waitscript_params: "
+            -e PG_HOST=<%= db_container_name %>
+            -e PG_USER=postgres
+            -e PGPASSWORD=#{testpass}
+            -e PG_DATABASE=postgres",
+          waitscript: <<~SCRIPT
+            #!/bin/sh
+
+            RETRIES=5
+
+            until psql -h $PG_HOST -U $PG_USER -d $PG_DATABASE -c "select 1" > /dev/null 2>&1 || [ $RETRIES -eq 0 ]; do
+             echo "Waiting for postgres server, $((RETRIES--)) remaining attempts..."
+             sleep 1
+            done
+          SCRIPT
+        }
+      end
+
+      def image_name
+        version = @options[:version] || 'alpine'
+        "postgres:#{version}"
+      end
+    end
+  end
+end

data/lib/kaiser/kaiserfile.rb

@@ -9,20 +9,37 @@ module Kaiser
                   :port,
                   :database_reset_command,
                   :attach_mounts,
-                  :server_type
+                  :server_type,
+                  :services
 
     def initialize(filename)
       Optimist.die 'No Kaiserfile in current directory' unless File.exist? filename
 
-      @databases = {}
+      @database = {
+        image: 'alpine',
+        port: 1234,
+        data_dir: '/tmp/data',
+        params: '',
+        commands: 'echo "no db"',
+        waitscript: 'echo "no dbwait"',
+        waitscript_params: ''
+      }
       @attach_mounts = []
       @params_array = []
       @server_type = :unknown
+      @database_reset_command = 'echo "no db to reset"'
+      @port = 1234
+      @services = {}
 
       instance_eval File.read(filename), filename
     end
 
+    def validate!
+      raise 'No dockerfile specified.' if @docker_file_contents.nil?
+    end
+
     def plugin(name)
+      require "kaiser/plugins/#{name}"
       raise "Plugin #{name} is not loaded." unless Plugin.loaded?(name)
 
       Plugin.all_plugins[name].new(self).on_init
@@ -76,5 +93,11 @@ module Kaiser
 
       @server_type = value
     end
+
+    def service(name, image: name)
+      raise "duplicate service #{name.inspect}" if @services.key?(name)
+
+      @services[name] = { image: image }
+    end
   end
 end

data/lib/kaiser/plugin.rb

@@ -56,3 +56,9 @@ module Kaiser
     end
   end
 end
+
+# Little stub to initialize the namespace
+module Kaiser
+  module Plugins
+  end
+end

data/lib/kaiser/plugins/database.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module Kaiser
+  module Plugins
+    class Database < Plugin
+      def on_init
+        @kaiserfile.define_singleton_method :def_db do |*args|
+          args[0] = { args.first => {} } unless args.first.is_a? Hash
+
+          option = args.first
+
+          driver_name = option.keys.first.to_s
+
+          begin
+            require "kaiser/databases/#{driver_name}"
+          rescue LoadError
+            raise "Unknown database '#{driver_name}'"
+          end
+
+          driver_class = Kaiser::Databases.const_get(driver_name.camelize)
+          db_driver = driver_class.new(option.values.first)
+
+          db(db_driver.image_name, **db_driver.options_hash)
+        end
+      end
+    end
+  end
+end

data/lib/kaiser/plugins/git_submodule.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
 module Kaiser
-  class GitSubmodule < Plugin
-    def on_init
-      `git submodule status`.lines.each do |line|
-        # The git-submodule man page says uninitialized submodules are prefixed with a -
-        # but I found this unreliable. While testing I pressed Control-C in the middle of
-        # the update command so some submodule would be initialized and others wouldn't.
-        # After that, the status command had removed the - for every submodule.
-        # Therefore we just check if there's files in the directory instead.
-        dir = line.strip.split(' ')[1]
-        if !Dir.exist?(dir) || Dir.empty?(dir) # rubocop:disable Style/Next
-          puts "Found uninitialized git submodule '#{dir}'"
-          system 'git submodule update --init --recursive'
+  module Plugins
+    class GitSubmodule < Plugin
+      def on_init
+        `git submodule status`.lines.each do |line|
+          # The git-submodule man page says uninitialized submodules are prefixed with a -
+          # but I found this unreliable. While testing I pressed Control-C in the middle of
+          # the update command so some submodule would be initialized and others wouldn't.
+          # After that, the status command had removed the - for every submodule.
+          # Therefore we just check if there's files in the directory instead.
+          dir = line.strip.split(' ')[1]
+          if !Dir.exist?(dir) || Dir.empty?(dir) # rubocop:disable Style/Next
+            puts "Found uninitialized git submodule '#{dir}'"
+            puts "please run 'git submodule update --init --recursive'"
+            exit 1
+          end
         end
       end
     end

data/lib/kaiser/service.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kaiser
+  # This class describes an app-specific service
+  class Service
+    attr_reader :name
+
+    def initialize(envname, name, service_info)
+      @envname = envname
+      @name = name
+      @service_info = service_info
+    end
+
+    def shared_name
+      "#{@envname}-#{name}"
+    end
+
+    def image
+      @service_info[:image]
+    end
+  end
+end

data/lib/kaiser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kaiser
-  VERSION = '0.4.5'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: kaiser
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.1
 platform: ruby
 authors:
 - David Siaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.6
 - !ruby/object:Gem::Dependency
   name: aruba-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -139,12 +167,16 @@ files:
 - lib/kaiser/cmds/up.rb
 - lib/kaiser/command_runner.rb
 - lib/kaiser/config.rb
+- lib/kaiser/databases/mysql.rb
+- lib/kaiser/databases/postgres.rb
 - lib/kaiser/docker_control.rb
 - lib/kaiser/dotter.rb
 - lib/kaiser/error.rb
 - lib/kaiser/kaiserfile.rb
 - lib/kaiser/plugin.rb
+- lib/kaiser/plugins/database.rb
 - lib/kaiser/plugins/git_submodule.rb
+- lib/kaiser/service.rb
 - lib/kaiser/version.rb
 homepage: https://github.com/kaiser
 licenses: