shiplane 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65c39ac05e2fac9eb88f9e80706577318ce04fe04f782d2a9730bc24000b218
-  data.tar.gz: adf16d46271c06b14f320ffe00bcdbb98d83dca3bcd3f5127bdbf3089b348b0c
+  metadata.gz: 7b5ceb3e3ec92da5d153b204c2f3d8e8d9108bc354c2690f6d9de39b69ee1893
+  data.tar.gz: f4e5b7340fa59249d4a3ffdfc2ce0f612a6c3faaf49208feebfb12fa0853f099
 SHA512:
-  metadata.gz: '08be86c9d7d83f8df85d111ab1f623d0c34683bbff17f50ef7e1139aee5a27862c078cb649b9256f4912f8139b1a3afde7358f7561d410f566a572bc49c5316c'
-  data.tar.gz: 5d65f4e2c62243105f865fe47deeb12e3a3b2fcd62e0e02842ae29ed086db883a28748ec497976faa37317d70d32dbd1d90f98fe32d8f046ff22983a6d7d1a97
+  metadata.gz: 74ce1231080dca4313fa9ed5c37c3197c2fd7e3d05ce275c13e1c0a4aac0a1a8c1f4d0a224b423141cdfc5633c57ad490c46834a8045395948ff9f082ff351dd
+  data.tar.gz: f627396ec65b1f5cba4215567d7b0559b91501e5336a3d03a560877d589b0eb452b8380bac1602931be97c7f98c978c53d2fe7713eb080b7600f558429ce6f87

data/README.md

@@ -131,6 +131,12 @@ You can run a deployment like so:
 bundle exec cap production deploy
 ```
 
+You can also deploy a specific Git SHA using the following syntax:
+
+```sh
+bundle exec cap production deploy[<sha>]
+```
+
 ### Troubleshooting
 This is as much a reminder to me as anyone else. If a new version of the gem has just been released and you are trying to pull it, make sure to run the following if bundler fails:
 ```

data/lib/capistrano/tasks/capistrano_stubs.rake

@@ -12,6 +12,22 @@ namespace :deploy do
   end
 end
 
+Rake::Task["deploy"].clear
+task :deploy, :sha do |t, args|
+  sha = args[:sha] || fetch(:sha) || `git rev-parse HEAD`.chomp
+  set :sha, sha
+
+  set(:deploying, true)
+  %w{ starting started
+      updating updated
+      publishing published
+      finishing finished }.each do |task|
+    invoke "deploy:#{task}"
+  end
+end
+Rake::Task["default"].clear
+task default: :deploy
+
 
 # deploy
 #   deploy:check

data/lib/capistrano/tasks/shiplane.rake

@@ -11,6 +11,6 @@ namespace :shiplane do
   end
 
   task :build, :sha do |t, args|
-    Shiplane::Build.build_latest!(args['sha'], fetch(:stage))
+    Shiplane::Build.build_latest!(args['sha'], postfix: fetch(:stage), stage: fetch(:stage))
   end
 end

data/lib/shiplane/build.rb

@@ -9,20 +9,21 @@ require_relative 'configuration'
 module Shiplane
   class Build
     extend Forwardable
-    attr_accessor :sha, :postfix, :tag_latest
+    attr_accessor :sha, :postfix, :tag_latest, :stage, :build_environment_variables
 
-    delegate %i(build_config project_config) => :shiplane_config
+    delegate %i(build_config project_config build_environment_filepath) => :shiplane_config
 
-    def initialize(sha, postfix:, tag_latest: false)
+    def initialize(sha, postfix:, tag_latest: false, stage: nil)
       @sha = sha
       @tag_latest = tag_latest
       @postfix = postfix
+      @stage = stage
 
-      Dotenv.overload File.join(Dir.pwd, build_config.fetch('environment_file', '.env'))
+      Dotenv.overload File.join(Dir.pwd, build_environment_filepath)
 
       # Add any ENV variable overrides from the capistrano configuration
-      environment_variable_overrides = fetch(:shiplane_build_environment_variables, {})
-      environment_variable_overrides.each do |key, value|
+      build_environment_variables = fetch(:shiplane_build_environment_variables, {})
+      build_environment_variables.each do |key, value|
         if value.is_a? Proc
           ENV[key.to_s] = value.call
         else
@@ -33,13 +34,13 @@ module Shiplane
 
     def build!
       unless File.exist?(File.join(project_folder, Shiplane::SHIPLANE_CONFIG_FILENAME))
-        Shiplane::CheckoutArtifact.checkout!(sha)
-        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha)
+        Shiplane::CheckoutArtifact.checkout!(sha, config: shiplane_config)
+        Shiplane::ConvertComposeFile.convert_output!(project_folder, sha, config: shiplane_config)
       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)
+        Shiplane::ConvertDockerfile.convert_output!(project_folder, attributes, compose_context, config: shiplane_config)
 
         FileUtils.cd project_folder do
           steps(artifact_name, attributes).select{|step| step.fetch(:condition, true) }.each do |step|
@@ -74,6 +75,8 @@ module Shiplane
     def build_command(artifact_name)
       [
         'docker-compose',
+        '--env-file',
+        build_environment_filepath,
         'build',
         build_cache_option,
         artifact_name,
@@ -125,7 +128,7 @@ module Shiplane
     end
 
     def shiplane_config
-      @shiplane_config ||= Shiplane::Configuration.new
+      @shiplane_config ||= Shiplane::Configuration.new(stage: stage)
     end
 
     def docker_config
@@ -187,12 +190,12 @@ module Shiplane
     end
 
     # API Helper Methods
-    def self.build!(sha, postfix = nil)
-      new(sha, postfix: postfix).build!
+    def self.build!(sha, postfix: nil, stage: nil)
+      new(sha, postfix: postfix, stage: stage).build!
     end
 
-    def self.build_latest!(sha, postfix = nil)
-      new(sha, postfix: postfix, tag_latest: true).build!
+    def self.build_latest!(sha, postfix: nil, stage: nil)
+      new(sha, postfix: postfix, tag_latest: true, stage: stage).build!
     end
   end
 end

data/lib/shiplane/checkout_artifact.rb

@@ -4,25 +4,23 @@ module Shiplane
   class CheckoutArtifact
     extend Forwardable
     attr_accessor :sha
+    attr_reader :shiplane_config
 
     delegate %i(build_config project_config) => :shiplane_config
 
-    def initialize(sha)
+    def initialize(sha, config: nil)
       @sha = sha
+      @shiplane_config = config || Shiplane::Configuration.new
 
       # call this before changing directories.
       # This prevents race conditions where the config file is accessed before being downloaded
-      shiplane_config
+      @shiplane_config
     end
 
     def appname
       @appname ||= project_config['appname']
     end
 
-    def shiplane_config
-      @shiplane_config ||= Shiplane::Configuration.new
-    end
-
     def github_token
       @github_token ||= ENV['GITHUB_TOKEN']
     end
@@ -40,7 +38,7 @@ module Shiplane
     end
 
     def make_directory
-      FileUtils.mkdir_p build_directory
+      FileUtils.mkdir_p app_directory
     end
 
     def checkout!
@@ -49,18 +47,40 @@ module Shiplane
       puts "Checking out Application #{appname}[#{sha}]..."
       make_directory
 
-      success = true
-      FileUtils.cd app_directory do
-        success = success && system("echo 'Downloading #{git_url}/archive/#{sha}.tar.gz --output #{appname}-#{sha}.tar.gz'")
-        success = success && system("curl -L #{git_url}/archive/#{sha}.tar.gz --output #{appname}-#{sha}.tar.gz")
-        success = success && system("tar -xzf #{appname}-#{sha}.tar.gz -C .")
-      end
+      success = system("echo 'Downloading #{git_url}/archive/#{sha}.tar.gz --output #{archive_filename}'")
+      success = success && download_archive
+      success = success && unpack_archive
 
       raise "Errors encountered while downloading archive" unless success
       puts "Finished checking out Application"
       tasks.each(&method(:send))
     end
 
+    def archive_filename
+      @archive_filename ||= "#{appname}-#{sha}.tar.gz"
+    end
+
+    def archive_path
+      @archive_path ||= File.join(app_directory, archive_filename)
+    end
+
+    def download_archive
+      return true if File.exist? archive_path
+
+      system("curl -L #{git_url}/archive/#{sha}.tar.gz --output #{archive_path}")
+    end
+
+    def unpack_archive
+      FileUtils.rm_rf(build_directory) if File.directory?(build_directory)
+      FileUtils.mkdir_p build_directory
+
+      success = true
+      FileUtils.cd app_directory do
+        success = success && system("tar -xzf #{appname}-#{sha}.tar.gz -C .")
+      end
+      success
+    end
+
     def tasks
       [:make_directories, :copy_env_files, :copy_insert_on_build_files, :unignore_required_directories]
     end
@@ -115,8 +135,8 @@ module Shiplane
       ['vendor']
     end
 
-    def self.checkout!(sha)
-      new(sha).checkout!
+    def self.checkout!(sha, config: nil)
+      new(sha, config: config).checkout!
     end
   end
 end

data/lib/shiplane/configuration.rb

@@ -1,9 +1,10 @@
 module Shiplane
   class Configuration
-    attr_accessor :project_folder
+    attr_accessor :project_folder, :stage
 
-    def initialize(project_folder = nil)
+    def initialize(project_folder: nil, stage: stage)
       @project_folder = project_folder || Dir.pwd
+      @stage = stage
     end
 
     def shiplane_config_file
@@ -30,6 +31,15 @@ module Shiplane
       @project_config ||= config.fetch('project', {})
     end
 
+    def build_environment_filepath
+      return @build_environment_filepath if defined? @build_environment_filepath
+
+      @build_environment_filepath = build_config.fetch('environment_file', '.env')
+      @build_environment_filepath = File.join(project_folder, "#{@build_environment_filepath}.#{stage}") if File.exist?(File.join(project_folder, "#{@build_environment_filepath}.#{stage}"))
+
+      @build_environment_filepath
+    end
+
     def self.config(project_folder = nil)
       new(project_folder).config
     end

data/lib/shiplane/convert_compose_file.rb

@@ -6,16 +6,14 @@ module Shiplane
   class ConvertComposeFile
     extend Forwardable
     attr_accessor :project_folder, :sha
+    attr_reader :shiplane_config
 
     delegate %i(build_config) => :shiplane_config
 
-    def initialize(project_folder, sha)
+    def initialize(project_folder, sha, config: nil)
       @project_folder = project_folder
       @sha = sha
-    end
-
-    def shiplane_config
-      @shiplane_config ||= Shiplane::Configuration.new
+      @shiplane_config = config || Shiplane::Configuration.new
     end
 
     def compose_config
@@ -48,8 +46,8 @@ module Shiplane
       puts "Compose File Converted..."
     end
 
-    def self.convert_output!(project_folder, sha)
-      new(project_folder, sha).convert_output!
+    def self.convert_output!(project_folder, sha, config: nil)
+      new(project_folder, sha, config: config).convert_output!
     end
   end
 end

data/lib/shiplane/convert_dockerfile.rb

@@ -4,23 +4,21 @@ module Shiplane
   class ConvertDockerfile
     extend Forwardable
     attr_accessor :artifact_context, :compose_context, :project_folder
+    attr_reader :shiplane_config
 
     delegate %i(build_config project_config) => :shiplane_config
 
-    def initialize(project_folder, artifact_context, compose_context)
+    def initialize(project_folder, artifact_context, compose_context, config: nil)
       @project_folder = project_folder
       @artifact_context = artifact_context
       @compose_context = compose_context
+      @shiplane_config = config || Shiplane::Configuration.new
     end
 
     def appname
       @appname ||= project_config['appname']
     end
 
-    def shiplane_config
-      @shiplane_config ||= Shiplane::Configuration.new
-    end
-
     def dockerfile_name
       @dockerfile_name ||= compose_context.fetch('build', {}).fetch('context', '.').tap do |filename|
         filename.gsub!(/^\.$/, 'Dockerfile')
@@ -53,8 +51,8 @@ module Shiplane
       puts "Dockerfile Converted..."
     end
 
-    def self.convert_output!(project_folder, artifact_context, compose_context)
-      new(project_folder, artifact_context, compose_context).convert_output!
+    def self.convert_output!(project_folder, artifact_context, compose_context, config: nil)
+      new(project_folder, artifact_context, compose_context, config: config).convert_output!
     end
   end
 end

data/lib/shiplane/deploy/container_configuration.rb

@@ -44,7 +44,11 @@ module Shiplane
       end
 
       def virtual_host
-        @virtual_host ||= options[:virtual_host]
+        return @virtual_host if defined?(@virtual_host) && @virtual_host
+
+        if options[:virtual_host]
+          @virtual_host = options[:virtual_host].is_a?(Proc) ? options[:virtual_host].call : options[:virtual_host]
+        end
       end
 
       def letsencrypt_host

data/lib/shiplane/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - John Epperson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shiplane_bootstrappers_chef
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement