shiplane 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 847be5563eac5f1b7d49c018a662a77d065d31022a1edf22bfeb347526459ada
-  data.tar.gz: ca5d1d1635161bd9cf4a5286fb2b42a13886ecd5b65df934f5dec5a560b7902e
+  metadata.gz: 3ae8f35e9d9eb37af8026cc7664a99a91df38b4509013077f346b19b09120c68
+  data.tar.gz: 6187a0375ef86304831505932a475d046afa0b74d81a3214a11bcd27ea50beef
 SHA512:
-  metadata.gz: 9109eed0795ebb3211b118563c89781f621b2bde7c16c38131c1d0b8f62075f1ed3a55da3a5a23ca584e75b211c237f1de4905b0d5bb0e7a17205e659c3d9b56
-  data.tar.gz: c07ff2c9e6bf6d68f2f983fa8497c2f7128533e34b986eb765d4aa7ea114eada3df65a20ec91d1e27f55c783ed01ad9c6206fc71225ec8a3d341a6a338ead732
+  metadata.gz: 24e26faa8239207b66a7d47b72cee33a0b48641d3574123422d2b861254c2302585708001cc69810d163cbe2535190aa4d13e8923d1b420f87d013ba83bff963
+  data.tar.gz: b0e074456a000474e575ca1f273bf2eb49128de78d96f68e9859dba0b1c58a8416077571d4f03aba023745298648be7a91e08779ef7ee8d9fa1d1cd6d451db0f

data/README.md

@@ -164,6 +164,11 @@ Shiplane::SafeBuild.wrap do
 end
 ```
 
+#### Using Build Cache
+Shiplane is designed to always build using the --no-cache flag in order to guaranteee clean, repeatable builds, but if you find yourself troubleshooting or otherwise needing to build multiple times, you might like to use the following flag to speed up the process. Note that this is intended to be a debugging tool. Using it for production building could potentially part of the build process to run in one context and another part to run in another. Such a case might cause both positive and negative results that are difficult to troubleshoot because they are not repeatable. Don't do this, but DO use this responsibly to make your life easier when troubleshooting.
+
+`USE_BUILD_CACHE=true bundle exec cap production shiplane`
+
 ## Becoming Involved
 ### Community Channels
 You can join our [Discord community](https://discord.gg/drrn2YG) to ask any questions you might have or to get ahold of someone in the community who might be able to help you (I hang out here just about every day of the week and most of the weekend). There is no guarantee of service implied, but we absolutely believe in helping out our fellow developers and will do so as we are able. If you feel you know some stuff about Shiplane, feel free to hang out and please help out as well!

data/lib/generators/shiplane/install/templates/shiplane.yml.erb

@@ -9,6 +9,9 @@ bootstrap:
     package_name: chefdk_3.6.57-1_amd64.deb
     package_url: https://packages.chef.io/files/stable/chefdk/3.6.57/ubuntu/18.04/chefdk_3.6.57-1_amd64.deb
 build:
+  registry:
+    # url: ghcr.io # for Github Container Service. Should work for similar services such as Gitlab
+    # url: :dockerhub # for default Dockerhub Service
   settings_folder: .shiplane
   environment_file: .env.production
   compose_filepath: docker-compose.yml

data/lib/shiplane/build.rb

@@ -21,6 +21,87 @@ module Shiplane
       Dotenv.overload File.join(Dir.pwd, build_config.fetch('environment_file', '.env'))
     end
 
+    def build!
+      unless File.exist?(File.join(project_folder, Shiplane::SHIPLANE_CONFIG_FILENAME))
+        Shiplane::CheckoutArtifact.checkout!(sha)
+        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha)
+      end
+
+      buildable_artifacts.each do |(artifact_name, attributes)|
+        compose_context = docker_config.fetch('services', {}).fetch(artifact_name.to_s, {})
+        Shiplane::ConvertDockerfile.convert_output!(project_folder, attributes, compose_context)
+
+        FileUtils.cd project_folder do
+          steps(artifact_name, attributes).select{|step| step.fetch(:condition, true) }.each do |step|
+            puts step[:notify_before] if step.has_key? :notify_before
+            success = system(step[:command])
+            raise StepFailureException.new(step[:command], artifact_name) unless success
+            puts step[:notify_after] if step.has_key? :notify_after
+          end
+        end
+      end
+    rescue StepFailureException => e
+      puts e.message
+      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+    end
+
+    def steps(artifact_name, attributes)
+      [
+        { command: build_command(artifact_name), notify_before: "Building Artifact: #{artifact_name}...", notify_after: "Docker Compose Built", stop_on_failure: true },
+        { command: tag_command(artifact_name, attributes, sha), notify_before: "Tagging Build [#{sha}]...", stop_on_failure: true },
+        { command: tag_command(artifact_name, attributes, "#{postfix}-#{sha}"), notify_before: "Tagging Build [#{postfix}-#{sha}]...", stop_on_failure: true, condition: !!postfix },
+        { command: tag_command(artifact_name, attributes, "#{postfix}-latest"), notify_before: "Tagging Build [#{postfix}-latest]...", stop_on_failure: true, condition: !!postfix && tag_latest },
+        { command: tag_command(artifact_name, attributes), notify_before: "Tagging Build [latest]...", stop_on_failure: true, condition: tag_latest },
+        { command: token_login_command , notify_before: "Logging into Container Registry...", stop_on_failure: true },
+        { command: push_command(attributes, "#{sha}"), notify_before: "Pushing Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true },
+        { command: push_command(attributes, "#{postfix}-#{sha}"), notify_before: "Pushing #{postfix} Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix },
+        { command: push_command(attributes, "#{postfix}-latest"), notify_before: "Pushing Latest #{postfix} Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix && tag_latest },
+        { command: push_command(attributes, "latest"), notify_before: "Pushing Latest Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: tag_latest },
+      ]
+    end
+
+    # Commands
+    def build_command(artifact_name)
+      [
+        'docker-compose',
+        'build',
+        build_cache_option,
+        artifact_name,
+      ].compact.join(' ')
+    end
+
+    def token_login_command
+      @token_login_command ||= [
+        'echo',
+        login_token,
+        '|',
+        'docker',
+        'login',
+        registry_url,
+        '--username',
+        login_username,
+        '--password-stdin',
+      ].compact.join(' ')
+    end
+
+    def tag_command(artifact_name, attributes, tag='latest')
+      [
+        'docker',
+        'tag',
+        build_output_image_name(artifact_name),
+        "#{repo_name(attributes)}:#{tag}",
+      ].compact.join(' ')
+    end
+
+    def push_command(attributes, tag='latest')
+      [
+        'docker',
+        'push',
+        "#{repo_name(attributes)}:#{tag}",
+      ].compact.join(' ')
+    end
+
+    # Properties
     def appname
       @appname ||= project_config['appname']
     end
@@ -45,44 +126,57 @@ module Shiplane
       build_config.fetch('artifacts', {})
     end
 
-    def build!
-      unless File.exist?(File.join(project_folder, Shiplane::SHIPLANE_CONFIG_FILENAME))
-        Shiplane::CheckoutArtifact.checkout!(sha)
-        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha)
-      end
+    def default_registry_configuration
+      {
+        'url' => :dockerhub,
+        'auth_method' => 'token',
+      }
+    end
 
-      buildable_artifacts.each do |(artifact_name, attributes)|
-        compose_context = docker_config.fetch('services', {}).fetch(artifact_name.to_s, {})
-        Shiplane::ConvertDockerfile.convert_output!(project_folder, attributes, compose_context)
+    def dockerhub?
+      registry_configuration['url'] == :dockerhub
+    end
 
-        FileUtils.cd project_folder do
-          steps(artifact_name, attributes).select{|step| step.fetch(:condition, true) }.each do |step|
-            puts step[:notify_before] if step.has_key? :notify_before
-            success = system(step[:command])
-            raise StepFailureException.new(step[:command], artifact_name) unless success
-            puts step[:notify_after] if step.has_key? :notify_after
-          end
-        end
-      end
-    rescue StepFailureException => e
-      puts e.message
-      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+    def token_auth?
+      registry_configuration['auth_method'] == 'token'
     end
 
-    def steps(artifact_name, attributes)
+    def registry_configuration
+      @registry_configuration ||= default_registry_configuration.merge(build_config.fetch('registry', {}))
+    end
+
+    def registry_url
+      @registry_url ||= dockerhub? ? nil : registry_configuration['url']
+    end
+
+    def repo_name(attributes)
       [
-        { command: "docker-compose build --no-cache #{artifact_name}", notify_before: "Building Artifact: #{artifact_name}...", notify_after: "Docker Compose Built", stop_on_failure: true },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:#{postfix}-#{sha}", notify_before: "Tagging Build...", stop_on_failure: true, condition: !!postfix },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:#{postfix}-latest", notify_before: "Tagging Build...", stop_on_failure: true, condition: !!postfix && tag_latest },
-        { command: "docker tag #{attributes['repo']}:#{sha} #{attributes['repo']}:latest", notify_before: "Tagging Latest Build...", stop_on_failure: true, condition: tag_latest },
-        { command: "echo '#{ENV['DOCKERHUB_PASSWORD']}' | docker login --username #{ENV['DOCKERHUB_USERNAME']} --password-stdin", notify_before: "Logging into DockerHub...", stop_on_failure: true },
-        { command: "docker push '#{attributes['repo']}:#{sha}'", notify_before: "Pushing Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true },
-        { command: "docker push '#{attributes['repo']}:#{postfix}-#{sha}'", notify_before: "Pushing #{postfix} Image", notify_after: "Completed Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix },
-        { command: "docker push '#{attributes['repo']}:#{postfix}-latest'", notify_before: "Pushing Latest #{postfix} Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: !!postfix && tag_latest },
-        { command: "docker push '#{attributes['repo']}:latest'", notify_before: "Pushing Latest Image", notify_after: "Completed Latest Artifact: #{artifact_name}...", stop_on_failure: true, condition: tag_latest },
-      ]
+        registry_url,
+        attributes['repo'],
+      ].compact.join('/')
+    end
+
+    def login_token
+      return ENV['DOCKERHUB_PASSWORD'] if dockerhub? && token_auth?
+
+      ENV['SHIPLANE_CONTAINER_REGISTRY_TOKEN']
+    end
+
+    def login_username
+      return ENV['DOCKERHUB_USERNAME'] if dockerhub? && token_auth?
+
+      ENV['SHIPLANE_CONTAINER_REGISTRY_USERNAME']
+    end
+
+    def build_output_image_name(artifact_name)
+      @build_output_image_name ||= "#{appname}-#{sha}_#{artifact_name}:latest"
+    end
+
+    def build_cache_option
+      ENV['USE_BUILD_CACHE'] == 'true' ? nil : "--no-cache"
     end
 
+    # API Helper Methods
     def self.build!(sha, postfix = nil)
       new(sha, postfix: postfix).build!
     end

data/lib/shiplane/convert_compose_file.rb

@@ -32,10 +32,6 @@ module Shiplane
 
     def converted_output
       @converted_output ||= converted_compose_hash.dup.tap do |hash|
-        build_config.fetch('artifacts', {}).each do |(appname, config)|
-          hash.deep_merge!({ 'services' => { appname => { 'image' => "#{config['repo']}:#{sha}" } } })
-        end
-
         hash.traverse! do |key, value|
           if (key == 'env_file' && value == '.env.development')
             [key, '.env.production']

data/lib/shiplane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shiplane
-  VERSION = "0.1.16"
+  VERSION = "0.1.17"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - John Epperson
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.17
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.1.17
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement