orchestration 0.6.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219067059e72b472f7697df1659e31d7d25b3f531a487ef0270949c95e427238
-  data.tar.gz: '079a57d5c7a6a3b59eefbd2e4b6be1b1630686d4c447b97a137c8a967f2c51a6'
+  metadata.gz: 99bdeb106830843d2a0e600151a4d80b411d21e86f25010d6c2379810ef85273
+  data.tar.gz: 4b3828ec78541d1680d3e5749c0a2e428bed328313d17e13d3f4e0dc1bdb0e8b
 SHA512:
-  metadata.gz: e277c0fac7a4f73254c8d011eb3a47b40bd92385b3348a21a345ab8188f246ebacd6f031edfb53fc18ba1d815c45540fd9b4c31fbaf44aa555c52fb6852f4159
-  data.tar.gz: 2ecf615a685df475723c4aef1bb86d60d7e400891a79af22941b2d5dd08f356db461492aa1fd092528e907ca4cc51ff8cb1a55c2d226dc51b99168a8f30fba50
+  metadata.gz: 0e5a03e78c1e442daa079a5d92540df52a148b7ea08b8fa3ecd55919d045e7fc239d5638d8a850565044b9c1d7065b39c4401a72db0daef0d299c622e86ee02f
+  data.tar.gz: e2061ef7628599f65c05d28380376ef841a329f85408c2dfa84172907ada7392dc0ba556b01a6559f3869b1f7b6809304615ebe91a9970e71adc31d04a0e82ed

data/README.md

@@ -13,6 +13,8 @@ make deploy manager=user@swarm.example.com env_file=/var/configs/myapp.env
 
 _Orchestration_ has been successfully used to build continuous delivery pipelines for numerous production applications with a wide range or requirements.
 
+See [upgrade guide](UPGRADE.md) if you are upgrading from `0.5.x` to `0.6.x`.
+
 ## Example
 
 The below screenshot demonstrates _Orchestration_ being installed in a brand new _Rails_ application with support for _PostgreSQL_ (via the _PG_ gem) and _RabbitMQ_ (via the _Bunny_ gem):
@@ -27,7 +29,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.6.0'
+gem 'orchestration', '~> 0.6.4'
 ```
 
 Install:

data/UPGRADE.md

@@ -0,0 +1,90 @@
+# Upgrade guide
+
+## 0.5 to 0.6
+
+### Delete/rename files
+
+Delete all files from `orchestration/` directory except:
+
+* `docker-compose.production.yml`
+* `docker-compose.development.yml`
+* `docker-compose.test.yml`
+* `Dockerfile`
+* `entrypoint.sh`
+
+Rename:
+
+```bash
+orchestration/docker-compose.production.yml => orchestration/docker-compose.deployment.yml
+```
+
+Any environment-specific compose files (e.g. `staging`) should also be removed as the same compose file is now used for all deployment stages.
+
+### Update Makefile
+
+Remove the first line of the main `Makefile` (in root of project) and replace it with the new `include` declaration:
+
+#### OLD
+
+```make
+include orchestration/Makefile
+```
+
+#### NEW
+
+```make
+include $(shell bundle exec ruby -e 'require "orchestration/make"')
+```
+
+#### Post-setup target
+
+Add a new target anywhere in the `Makefile` called `post-setup`:
+
+```make
+.PHONY: post-setup
+post-setup:
+	echo 'doing post setup stuff'
+```
+
+Replace the body of this target with any commands that you want to take place once the initial setup (launching development/test containers, running migrations, etc.) is complete. For example, running migrations for a secondary database.
+
+### Continuous Integration files
+
+Update any continuous integration scripts (e.g. `Jenkinsfile`) to run the `setup` target before `test`, e.g.:
+
+#### OLD
+
+```Jenkinsfile
+    stage('Test') {
+      steps {
+        sh 'make test sidecar=1'
+      }
+    }
+```
+
+#### NEW
+
+```Jenkinsfile
+    stage('Test') {
+      steps {
+        sh 'make setup test sidecar=1'
+      }
+    }
+```
+
+(`sidecar` may or may not be needed depending on your setup but, if it was there prior to upgrade, then it should remain after upgrade).
+
+### General Usage
+
+All _Orchestration_ commands behave exactly the same as before with the exception of the `test` target. Now, instead of running `make test` to launch all containers and then run tests, _Rubocop_, etc., you must run `make setup test`.
+
+This will set up the test environment and then run tests. You may then run `make test` to just run tests without having to go through the full setup process again.
+
+Similarly you can set up the development environment by just running `make setup`.
+
+To set up the test environment and run tests as two separate steps (i.e. equivalent of using the shorthand `make setup test`) you can run:
+
+```bash
+make setup RAILS_ENV=test
+make test
+```

data/config/locales/en.yml

@@ -29,6 +29,7 @@ en:
     rake:
       config: "Parse and output Orchestration config (internal use)"
       healthcheck: "Execute healthcheck; used for HEALTHCHECK command in Docker image"
+      compose_services: "Output configured services for a given environment (RAILS_ENV)"
       install: "Install Orchestration tools"
       install_makefile: "(Re)create orchestration/Makefile"
       wait: "Wait for development/test dependencies to be available"

data/lib/orchestration/docker_compose/app_service.rb

@@ -98,9 +98,10 @@ module Orchestration
           'RAILS_LOG_TO_STDOUT' => '1',
           'RAILS_SERVE_STATIC_FILES' => '1',
           'WEB_PRELOAD_APP' => '1',
-          'WEB_HEALTHCHECK_PATH' => '/',
+          'WEB_HEALTHCHECK_PATH' => '/healthcheck',
+          'WEB_PORT' => 8080,
           'DATABASE_URL' => database_url
-        }.merge(inherited_environment.map { |key| [key, nil] }.to_h).merge(rabbitmq_urls)
+        }.merge(inherited_environment.to_h { |key| [key, nil] }).merge(rabbitmq_urls)
       end
 
       def rabbitmq_urls
@@ -114,7 +115,7 @@ module Orchestration
           'postgresql' => 'postgresql://postgres:password@database-local:5432/production',
           'mysql2' => 'mysql2://root:password@database-local:3306/production',
           'sqlite3' => 'sqlite3:db/production.sqlite3'
-        }.fetch(DockerCompose::ComposeConfiguration.database_adapter_name)
+        }.fetch(DockerCompose::ComposeConfiguration.database_adapter_name, nil)
       end
 
       def inherited_environment

data/lib/orchestration/docker_compose/compose_configuration.rb

@@ -48,6 +48,8 @@ module Orchestration
 
       def config
         @config ||= @env.docker_compose_config
+      rescue Errno::ENOENT
+        {}
       end
 
       def listener?(name)

data/lib/orchestration/environment.rb

@@ -69,12 +69,12 @@ module Orchestration
     end
 
     def default_app_name
-      default = docker_filter(root.basename.to_s)
+      default = docker_filter(root.basename.to_s, underscore: true)
       return default unless defined?(Rails)
       # Edge case if Rails is used as a dependency but we are not a Rails app:
       return default if rails_application == Object
 
-      docker_filter(rails_application.name.underscore)
+      docker_filter(rails_application.name.underscore, underscore: true)
     end
 
     def rabbitmq_url
@@ -126,10 +126,14 @@ module Orchestration
       app_class.parent
     end
 
-    def docker_filter(string)
+    def docker_filter(string, underscore: false)
       # Filter out characters not accepted by Docker Hub
       permitted = [('0'..'9'), ('a'..'z')].map(&:to_a).flatten
-      string.chars.select { |char| permitted.include?(char) }.join
+      string.chars.select do |char|
+        next true if underscore && char == '_'
+
+        permitted.include?(char)
+      end.join
     end
   end
 end

data/lib/orchestration/install_generator.rb

@@ -30,7 +30,6 @@ module Orchestration
     def application_makefile
       path = @env.root.join('Makefile')
       simple_copy('application.mk', path) unless File.exist?(path)
-      inject_if_missing(path, 'include orchestration/Makefile')
     end
 
     def dockerfile

data/lib/orchestration/make/orchestration.mk

@@ -141,6 +141,8 @@ docker_config:=$(shell DEVPACK_DISABLE=1 RAILS_ENV=development ${bundle_cmd} rak
 docker_organization=$(word 1,$(docker_config))
 docker_repository=$(word 2,$(docker_config))
 
+compose_services:=$(shell ${rake} orchestration:compose_services RAILS_ENV=${env})
+
 ifeq (,$(project_name))
   project_base = ${docker_repository}_${env}
 else
@@ -209,9 +211,10 @@ ifndef network
 start: network := ${compose_project_name}
 endif
 start: _create-log-directory _clean-logs
+ifneq (,${compose_services})
 	@$(call system,${compose_human} up --detach)
 ifeq (${env},$(filter ${env},test development))
-	@${compose} up --detach --force-recreate --renew-anon-volumes --remove-orphans ${services} ${log} || ${exit_fail}
+	${compose} up --detach --force-recreate --renew-anon-volumes --remove-orphans ${services} ${log} || ${exit_fail}
 	@[ -n '${sidecar}' ] && \
          ( \
            $(call echo,(joining dependency network ${cyan}${network}${reset})) ; \
@@ -229,10 +232,12 @@ endif
 	@$(call echo,${env_human} containers started ${tick})
 	@$(call echo,Waiting for services to become available)
 	@$(call make,wait) 2>${stderr} || ${exit_fail}
+endif
 
 .PHONY: stop
 stop: network := ${compose_project_name}
 stop:
+ifneq (,${compose_services})
 	@$(call echo,Stopping ${env_human} containers)
 	@$(call system,${compose_human} down)
 	@if docker ps --format "{{.ID}}" | grep -q $(shell hostname) ; \
@@ -244,6 +249,7 @@ stop:
             ${compose} down ${log} || ${exit_fail} ; \
           fi
 	@$(call echo,${env_human} containers stopped ${tick})
+endif
 
 .PHONY: logs
 logs:
@@ -288,7 +294,9 @@ db-console:
 	@${rake} orchestration:db:console RAILS_ENV=${env}
 
 .PHONY: setup
+ifneq (,$(wildcard config/database.yml))
 setup: url = $(shell ${rake} orchestration:db:url RAILS_ENV=${env})
+endif
 setup: _log-notify
 	@$(call echo,Setting up ${env_human} environment)
 	@$(call make,start env=${env})
@@ -297,8 +305,8 @@ ifneq (,$(wildcard config/database.yml))
 	@$(call system,rake db:create DATABASE_URL="${url}")
 	@${rake} db:create RAILS_ENV=${env} ${log} || : ${log}
   ifneq (,$(wildcard db/structure.sql))
-	@$(call system,rake db:structure:load DATABASE_URL="${url}")
-	@${rake} db:structure:load DATABASE_URL='${url}' ${log} || ${exit_fail}
+	@$(call system,rake db:schema:load DATABASE_URL="${url}")
+	@${rake} db:schema:load DATABASE_URL='${url}' ${log} || ${exit_fail}
   else ifneq (,$(wildcard db/schema.rb))
 	@$(call system,rake db:schema:load DATABASE_URL="${url}")
 	@${rake} db:schema:load DATABASE_URL='${url}' ${log} || ${exit_fail}
@@ -306,9 +314,9 @@ ifneq (,$(wildcard config/database.yml))
 	@$(call system,rake db:migrate DATABASE_URL="${url}")
 	@${rake} db:migrate RAILS_ENV=${env}
 endif
-	@$(MAKE) -n post-setup >/dev/null 2>&1 \
-          && $(call system,make post-setup RAILS_ENV=${env}) \
-          && $(MAKE) post-setup RAILS_ENV=${env}
+	@if $(MAKE) -n post-setup >/dev/null 2>&1; then \
+          $(call system,make post-setup RAILS_ENV=${env}) \
+          && $(MAKE) post-setup RAILS_ENV=${env}; fi
 	@$(call echo,${env_human} environment setup complete ${tick})
 
 .PHONY: dump
@@ -437,12 +445,11 @@ endif
 ifdef include
 	@$(call echo,Including files from: ${cyan}${include}${reset})
 	@(while read line; do \
-	    _system () { echo '${system_prefix}' $$1 }
             export line; \
             include_dir="${build_dir}/$$(dirname "$${line}")/" && \
             mkdir -p "$${include_dir}" && cp "$${line}" "$${include_dir}" \
             && (cd '${orchestration_dir}/.build/' && tar rf 'context.tar' "$${line}"); \
-	    _system "tar rf 'context.tar' '$${line}'")
+	    echo "${system_prefix}" "tar rf 'context.tar' '$${line}'"; \
           done < '${include}') ${log} || ${exit_fail}
 	@$(call echo,Build context ${green}ready${reset} ${tick})
 endif

data/lib/orchestration/templates/Dockerfile.erb

@@ -19,7 +19,9 @@ RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - \
  && npm install -g yarn<% end %>
 WORKDIR /app
 COPY .build/Gemfile .build/Gemfile.lock ./
-RUN bundle install --without development test --deployment
+RUN bundle config set deployment 'true' \
+ && bundle config set without 'development test' \
+ && bundle install
 ADD .build/context.tar .
 <% if defined?(Webpacker) %>RUN . /root/.bashrc ; NODE_ENV=production RAILS_ENV=production yarn install && NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=abc123 bundle exec rake assets:precompile<% elsif Rake::Task.tasks.map(&:name).include?('assets:precompile') %>RUN NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=abc123 bundle exec rake assets:precompile<% end %>
 RUN echo "${GIT_COMMIT}" > /app/GIT_COMMIT

data/lib/orchestration/templates/application.mk.erb

@@ -24,7 +24,7 @@ test:
 #
 .PHONY: post-setup
 post-setup:
-	# Setup tasks that are not already provided by Orchestration go here.
+	@# Setup tasks that are not already provided by Orchestration go here.
 
 #
 # Launch all dependencies needed for a development environment and set up the

data/lib/orchestration/templates/puma.rb.erb

@@ -1,6 +1,6 @@
 environment ENV.fetch('RAILS_ENV') { 'development' }
 
-port ENV.fetch('WEB_PORT') { 8080 }
+port ENV.fetch('WEB_PORT') { 3000 }
 workers ENV.fetch('WEB_CONCURRENCY') { 4 }
 threads_count = ENV.fetch('RAILS_MAX_THREADS') { 8 }
 

data/lib/orchestration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orchestration
-  VERSION = '0.6.0'
+  VERSION = '0.6.4'
 end

data/lib/tasks/orchestration.rake

@@ -22,7 +22,13 @@ namespace :orchestration do
   namespace :db do
     desc I18n.t('orchestration.rake.db.url')
     task :url do
-      puts DatabaseUrl.to_active_record_url(Rails.application.config_for(:database))
+      config = Rails.application.config_for(:database)
+
+      if config[:adapter] == 'sqlite3'
+        puts "sqlite3:#{config[:database]}"
+      else
+        puts DatabaseUrl.to_active_record_url(config)
+      end
     end
 
     desc I18n.t('orchestration.rake.db.console')
@@ -33,6 +39,12 @@ namespace :orchestration do
     end
   end
 
+  desc I18n.t('orchestration.rake.compose_services')
+  task :compose_services do
+    config = Orchestration::DockerCompose::ComposeConfiguration.new(Orchestration::Environment.new)
+    puts config.services.keys.join(' ') unless config.services.nil? || config.services.empty?
+  end
+
   desc I18n.t('orchestration.rake.healthcheck')
   task :healthcheck do
     Orchestration::DockerHealthcheck.execute

data/orchestration.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'Docker orchestration toolkit'
   spec.description = 'Tools to help launch apps in Docker'
   spec.homepage = url
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -21,7 +22,7 @@ Gem::Specification.new do |spec|
     end
   end
 
-  spec.required_ruby_version = '~> 2.6'
+  spec.required_ruby_version = '~> 2.7'
   spec.bindir = 'bin'
   spec.executables = []
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.4
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -349,6 +349,7 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- UPGRADE.md
 - bin/console
 - bin/setup
 - config/locales/en.yml
@@ -413,7 +414,8 @@ files:
 - orchestration.gemspec
 homepage: https://github.com/bobf/orchestration
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -422,14 +424,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Docker orchestration toolkit