docker-stack 0.1.0

data/lib/docker/stack/rake_task.rb

@@ -0,0 +1,63 @@
+require 'docker/stack'
+
+# rubocop:disable all
+module Docker
+  module Stack
+    module RakeTask
+      class << self
+        include ::Rake::DSL if defined?(::Rake::DSL)
+
+        def load_tasks(force_env: nil, cleanup: false)
+          desc 'Clean up the development stack'
+          task :clean do
+            Controller.new(env: force_env, cleanup: true).down
+          end
+
+          desc 'Run the stack in the background'
+          task :daemon do
+            Controller.new(env: force_env, daemon: true).start
+          end
+
+          desc 'Bring down the stack'
+          task :down do
+            Controller.new(env: force_env, cleanup: cleanup).down
+          end
+
+          desc 'Show the server logs'
+          task :logs do
+            services = ENV['SERVICES'].to_s.split(/[\s,;]+/)
+            Controller.new(env: force_env).logs(*services)
+          end
+
+          desc 'Remove containers, volumes, and images'
+          task :reset do
+            Controller.new(env: force_env).reset! do |result|
+              results = JSON.parse(result)
+              results.each do |result_hash|
+                result_hash.each_pair do |action, target|
+                  puts "#{action} #{target}"
+                end
+              end
+            end
+          end
+
+          desc 'Show server status'
+          task :status do
+            status = Controller.new(env: force_env).status
+            puts '%-20s %-16s %-20s' % ['SERVICE', 'STATUS', 'UPTIME']
+            puts '-' * 56
+            status.each do |s|
+              puts '%-20s %-16s %-20s' % s.values_at(:service, :status, :running)
+            end
+          end
+
+          desc 'Run the stack in the foreground'
+          task :up do
+            Controller.new(env: force_env, cleanup: cleanup).start
+          end
+        end
+      end
+    end
+  end
+end
+# rubocop:enable all

data/lib/docker/stack/version.rb

@@ -0,0 +1,5 @@
+module Docker
+  module Stack
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/generators/docker/stack/install_generator.rb

@@ -0,0 +1,48 @@
+require 'generators/docker/stack/util'
+require 'active_support/core_ext/hash/keys'
+
+module Docker
+  module Stack
+    class InstallGenerator < Rails::Generators::Base
+      include Util
+
+      class_option :env, type: :string, default: nil
+      class_option :services, type: :string, default: ''
+
+      source_root File.expand_path('templates', __dir__)
+      desc %(This generator makes the following changes to your application:
+     1. Creates skeleton docker-compose.yml files for development and test mode
+        with fedora, and solr containers.
+     2. Creates lib/tasks/docker.rake.
+)
+
+      def create_service_configs
+        environments.each do |env|
+          create_file compose_file_path(env), empty_service_config.to_yaml, force: false, skip: true
+        end
+      end
+
+      def create_services
+        env_param = "--env #{options[:env]}" unless options[:env].nil?
+        services.each do |service|
+          generate "docker:stack:service:#{service}", env_param
+        end
+      end
+
+      def add_rake_tasks
+        copy_file 'docker.rake', 'lib/tasks/docker.rake'
+      end
+
+      no_tasks do
+        def environments
+          return %w[development test] if options[:env].nil?
+          options[:env].split(/,/)
+        end
+
+        def services
+          options[:services].split(/,/)
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/service.rb

@@ -0,0 +1,49 @@
+require 'generators/docker/stack/util'
+require 'active_support/core_ext/hash/deep_merge'
+require 'ostruct'
+
+module Docker
+  module Stack
+    module Service
+      def self.included(base)
+        base.include Util
+
+        base.class_option :env, type: :string, default: 'development,test'
+
+        base.define_method :add_service do
+          options[:env].split(/,/).each do |env|
+            @env = env
+            add_service_for_environment
+          end
+        end
+
+        base.no_tasks do
+          def service
+            self.class.generator_name
+          end
+
+          def add_service_for_environment
+            new_service_config = current_service_config.deep_merge(service_from_template(service))
+            say_status :update, "#{relative_to_original_destination_root(compose_file_full_path)} [#{service}]", true
+            File.open(compose_file_full_path, 'w') do |f|
+              YAML.dump(new_service_config, f)
+            end
+          end
+
+          def service_from_template(service)
+            source  = File.expand_path(find_in_source_paths("services/#{service}.yml.erb"))
+            context = OpenStruct.new(env: @env, port_offset: port_offset).instance_eval { binding }
+            yaml = Thor::Actions::CapturableERB.new(::File.binread(source), nil, '-', '@output_buffer').tap do |erb|
+              erb.filename = source
+            end.result(context)
+            YAML.safe_load(yaml)
+          end
+
+          def port_offset
+            { 'development' => 0, 'test' => 2 }[@env] || 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/service/fedora_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/docker/stack/service'
+
+module Docker
+  module Stack
+    module Service
+      class FedoraGenerator < Rails::Generators::Base
+        include Docker::Stack::Service
+
+        desc %(This generator makes the following changes to your application:
+       1. Adds a fedora service configuration to the docker-compose.yml files.
+       2. Creates a config/fedora.yml file pointing to the new service.
+  )
+
+        def install_service
+          copy_file 'config/fedora.yml', 'config/fedora.yml'
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/service/postgres_generator.rb

@@ -0,0 +1,22 @@
+require 'generators/docker/stack/service'
+
+module Docker
+  module Stack
+    module Service
+      class PostgresGenerator < Rails::Generators::Base
+        include Docker::Stack::Service
+
+        desc %(This generator makes the following changes to your application:
+       1. Adds a db service configuration to the docker-compose.yml files.
+       2. Creates a config/database.yml file pointing to the new service.
+       3. Adds the 'pg' gem to the Gemfile.
+  )
+
+        def install_service
+          copy_file 'config/database.yml', 'config/database.yml'
+          gem 'pg'
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/service/redis_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/docker/stack/service'
+
+module Docker
+  module Stack
+    module Service
+      class RedisGenerator < Rails::Generators::Base
+        include Docker::Stack::Service
+
+        desc %(This generator makes the following changes to your application:
+       1. Adds a redis service configuration to the docker-compose.yml files.
+       2. Creates a config/redis.yml file pointing to the new service.
+  )
+
+        def install_service
+          copy_file 'config/redis.yml', 'config/redis.yml'
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/service/solr_generator.rb

@@ -0,0 +1,22 @@
+require 'generators/docker/stack/service'
+
+module Docker
+  module Stack
+    module Service
+      class SolrGenerator < Rails::Generators::Base
+        include Docker::Stack::Service
+
+        desc %(This generator makes the following changes to your application:
+       1. Adds a solr service configuration to the docker-compose.yml files.
+       2. Creates a config/solr.yml file pointing to the new service.
+       3. Adds a solr directory to the root containing solr config files for the solr service.
+  )
+
+        def install_service
+          copy_file 'config/solr.yml', 'config/solr.yml'
+          directory 'solr'
+        end
+      end
+    end
+  end
+end

data/lib/generators/docker/stack/templates/config/database.yml

@@ -0,0 +1,23 @@
+default: &default
+  adapter: postgresql
+  host: localhost
+  encoding: unicode
+  pool: 5
+  username: docker
+  password: d0ck3r
+
+development:
+  <<: *default
+  port: 5433
+  database: docker_dev
+
+test:
+  <<: *default
+  port: <%= Rails.env.development? ? 5433 : 5435 %>
+  database: docker_test
+
+production:
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+  database: db/production.sqlite3

data/lib/generators/docker/stack/templates/config/fedora.yml

@@ -0,0 +1,15 @@
+development:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:<%= ENV['FCREPO_DEVELOPMENT_PORT'] || 8984 %>/rest
+  base_path: /dev
+test:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:<%= ENV['FCREPO_TEST_PORT'] || 8986 %>/rest
+  base_path: /test
+production:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:8983/fedora/rest
+  base_path: /prod

data/lib/generators/docker/stack/templates/config/redis.yml

@@ -0,0 +1,9 @@
+development:
+  host: localhost
+  port: 6380
+test:
+  host: localhost
+  port: 6381
+production:
+  host: <%= ENV['REDIS_HOST'] || 'localhost' %>
+  port: <%= ENV['REDIS_PORT'] || 6379 %>

data/lib/generators/docker/stack/templates/config/solr.yml

@@ -0,0 +1,7 @@
+# This is a sample config file that points to a solr server for each environment
+development:
+  url: http://127.0.0.1:<%= ENV['SOLR_TEST_PORT'] || 8983 %>/solr/development-core
+test:
+  url: http://127.0.0.1:<%= ENV['SOLR_TEST_PORT'] || 8985 %>/solr/test-core
+production:
+  url: http://127.0.0.1:8983/solr/donut

data/lib/generators/docker/stack/templates/docker.rake

@@ -0,0 +1,25 @@
+require 'docker/stack/rake_task'
+
+def get_named_task(task_name)
+  Rake::Task[task_name]
+rescue RuntimeError
+  nil
+end
+
+namespace :docker do
+  namespace(:dev)  { Docker::Stack::RakeTask.load_tasks }
+  namespace(:test) { Docker::Stack::RakeTask.load_tasks(force_env: 'test', cleanup: true) }
+
+  desc 'Spin up test stack and run specs'
+  task :spec do
+    Rails.env = 'test'
+    Docker::Stack::Controller.new(cleanup: true).with_containers do
+      Rake::Task['db:setup'].invoke
+
+      task = get_named_task(ENV['SPEC_TASK']) ||
+             get_named_task('spec') ||
+             get_named_task('rspec')
+      task.invoke unless task.nil?
+    end
+  end
+end

data/lib/generators/docker/stack/templates/services/fedora.yml.erb

@@ -0,0 +1,9 @@
+volumes:
+  fedora:
+services:
+  fedora:
+    image: nulib/fcrepo4
+    volumes:
+      - fedora:/data
+    ports:
+      - "<%= 8984 + port_offset %>:8080"

data/lib/generators/docker/stack/templates/services/postgres.yml.erb

@@ -0,0 +1,13 @@
+volumes:
+  db:
+services:
+  db:
+    image: healthcheck/postgres:alpine
+    volumes:
+      - db:/data
+    environment:
+      - PGDATA=/data
+      - POSTGRES_USER=docker
+      - POSTGRES_PASSWORD=d0ck3r
+    ports:
+      - "<%= 5433 + port_offset %>:5432"

data/lib/generators/docker/stack/templates/services/redis.yml.erb

@@ -0,0 +1,10 @@
+services:
+  redis:
+    image: redis:alpine
+    ports:
+      - "<%= 6380 + port_offset %>:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 30s
+      timeout: 5s
+      retries: 3

data/lib/generators/docker/stack/templates/services/solr.yml.erb

@@ -0,0 +1,20 @@
+volumes:
+  solr:
+services:
+  solr:
+    image: solr:7.2-alpine
+    ports:
+      - "<%= 8983 + port_offset %>:8983"
+    volumes:
+      - solr:/opt/solr/server/solr/mycores
+      - ../../solr:/solr_config
+    entrypoint:
+      - docker-entrypoint.sh
+      - solr-precreate
+      - <%= env %>-core
+      - /solr_config/conf
+    healthcheck:
+      test: ["CMD", "wget", "-O", "/dev/null", "http://localhost:8983/solr/"]
+      interval: 30s
+      timeout: 5s
+      retries: 3

data/lib/generators/docker/stack/templates/solr/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/lib/generators/docker/stack/templates/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/lib/generators/docker/stack/templates/solr/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>