shiplane 0.2.6 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5acdecf601b6e3dcc169a7034ba182339401e432a4ede3a718f0fce112f400
-  data.tar.gz: 311b91b9388650ccdf260dca0a92f99c776019e182a05044b31fb352a0a5a51b
+  metadata.gz: 6bbe97524b9b82e6b2582798b437608cff1824a7c03f5551c5de8fed3d4693c1
+  data.tar.gz: 8e0b79ded64782d46a625c23bc7d093e6e6e7f38fca3306711bb71374b10816c
 SHA512:
-  metadata.gz: 3fd03c6026a3a18cbcbdf974830f826c4c766712b7859de225a86b50c15e45970e9ac03a531204af708a5e81ffa8e79f3fbe39b8640f7e9443b2b68c19c0a7eb
-  data.tar.gz: dda7a3732b07058709461b24deccf24a9c471381af8667e915344e0ee1dcb9f7ac3b4e969e7e9d93ef1f541eeb064c491858aa104733e7485258f838bc90b926
+  metadata.gz: 7834ebda28494d3a6b99315bb841f22bb11fe45aee07fabd652d2e2e5e684082169d1c4abcc362e431d9f4c1cd269724b6c198c1cc272286ad5508211267a42d
+  data.tar.gz: 802840623b6b1d23147bc59b8b9e6adad23e74eff89cb2b12a13768faceaca6b249061888365302694c5bf10242cec02dd29947f3dbd5b2740e6653a4007b989

data/README.md

@@ -118,6 +118,33 @@ You can build a docker container based on the HEAD of your current branch like s
 bundle exec cap production shiplane
 ```
 
+### Environment Variables
+Shiplane uses specific .env files to make sure that a given build environment contains the appropriate environment variables. These are used for 3 separate purposes:
+- The environment that the Shiplane process is running in. For example, if you want to authenticate with a Github private repo, you will need to set the GITHUB_TOKEN environment variable in your .env file so that Shiplane can authenticate.
+- The buildtime step of building the container. If your container needs environment variables to be set during buildtime so that the container can be built, you will need these builtime env variables. Examples might include a Github Token used to pull dependencies from private repositories on Github during buildtime. These variables will not be stored in your container, but you may need to remove any traces of these variables that might be stored in your container as side effects if your dependency ecosystem does this. For example, Ruby Gems downloaded during buildtime using an Github Token will result in that token being stored in the Gemfile.lock file. The [examples folder](examples/rails_app/.shiplane/production_dockerfile_stages) provide an example of a means of removing this after bundling. You may consider a similar step during your build process.
+- The runtime environment may require some environment variables. For example, you might have a bunch of ENVIRONMENT VARIABLES necessary for your application to run (less secure, but simpler), or, you might need an environment variable to access a vault somewhere containing other runtime ENVIRONMENT VARIABLES (more secure, slightly more difficult), or, you may have none at all and use another mechanism to inject appropriate settings (you have more control over this, but the most difficult).
+
+## Important ENVIRONMENT VARIABLES for the Shiplane Process
+```sh
+GITHUB_TOKEN=XXXXXXXXXX # required if pulling from a private Github Repository
+BITBUCKET_TOKEN=XXXXXXXXXX # required if pulling from a private Bitbucket Repository
+BITBUCKET_USERNAME=XXXXXXXXXX # required if pulling from a private Bitbucket Repository
+```
+
+## Important ENVIRONMENT VARIABLES for buildtime
+```sh
+DOCKERHUB_PASSWORD=XXXXXXXXXX # deprecated but still supported token/password specifically for DOCKERHUB
+DOCKERHUB_USERNAME=XXXXXXXXXX # deprecated but still supported username specifically for DOCKERHUB
+SHIPLANE_CONTAINER_REGISTRY_TOKEN=XXXXXXXXXX # Token for container registry authentication
+SHIPLANE_CONTAINER_REGISTRY_USERNAME=XXXXXXXXXX # Username for container registry authentication
+RAISE_EXCEPTIONS_ON_FAILED_BUILD=true # Tells Shiplane to stop on a failed build and raise an exception. Defaults to 'false'
+```
+## Important ENVIRONMENT VARIABLES for runtime
+# Rails Environment Variable sample
+```sh
+RAILS_MASTER_KEY=XXXXXXXXXX
+```
+
 #### Deploying
 Shiplane provides tasks to help you deploy your code. These tasks depend on your deployment framework, but each task appropriately launches your docker containers on your selected framework.
 

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/generators/shiplane/install/templates/shiplane.yml.erb

@@ -1,17 +1,18 @@
 project:
   appname: <%= app_name %>
   version_control: git
-  # The origin url on Github
-  # origin: username/repo_title
+  version_control_host: github # alternately, use `bitbucket` if your application is hosted on BitBucket
+  # The origin url on Github or Bitbucket
+  origin: #username/<%= app_name %>
 bootstrap:
   env_file: .env.production
   chef-bootstrapper:
-    package_name: chefdk_3.13.1-1_amd64.deb
-    package_url: https://packages.chef.io/files/stable/chefdk/3.13.1/ubuntu/16.04/chefdk_3.13.1-1_amd64.deb
+    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
+    # url: dockerhub # for default Dockerhub Service
   settings_folder: .shiplane
   environment_file: .env.production
   compose_filepath: docker-compose.yml
@@ -20,7 +21,7 @@ build:
   artifacts:
     container-name:
       tag: <%= app_name %>-base:latest
-      repo: kirillian2/<%= app_name %>
+      repo: #username/<%= app_name %>
       ports:
         - "3000:3000"
   compose:
@@ -40,8 +41,8 @@ deploy:
       requires_sudo: false
       # Put SSH options here
       # ssh_options:
-      #   user: a_user
-      #   keys: "path/to/ssh/keys"
+      #   user: <%= ENV['SSH_USERNAME_ENV_VARIABLE_HERE'] %>
+      #   keys: <%= ENV['PATH_TO_SSH_KEYS_HERE'] %>
       #   forward_agent: true
       #   auth_methods:
       #     - publickey

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|
@@ -52,7 +53,7 @@ module Shiplane
       end
     rescue StepFailureException => e
       puts e.message
-      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD']
+      raise if ENV['RAISE_EXCEPTIONS_ON_FAILED_BUILD'] == 'true'
     end
 
     def steps(artifact_name, attributes)
@@ -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
@@ -144,7 +147,7 @@ module Shiplane
     end
 
     def dockerhub?
-      registry_configuration['url'] == :dockerhub
+      registry_configuration['url'].to_s == 'dockerhub'
     end
 
     def token_auth?
@@ -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,31 +4,54 @@ 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
+    def bitbucket_origin?
+      project_config['version_control_host'] == 'bitbucket'
+    end
+
+    def github_origin?
+      project_config['version_control_host'] == 'github'
     end
 
     def github_token
       @github_token ||= ENV['GITHUB_TOKEN']
     end
 
+    def bitbucket_token
+      @bitbucket_token ||= ENV['BITBUCKET_APP_PASSWORD']
+    end
+
+    def bitbucket_username
+      @bitbucket_username ||= ENV['BITBUCKET_APP_USERNAME']
+    end
+
     def git_url
-      "https://#{github_token ? "#{github_token}@" : ''}github.com/#{project_config['origin']}"
+      return github_url if github_origin?
+      return bitbucket_url if bitbucket_origin?
+    end
+
+    def github_url
+      "https://#{github_token ? "#{github_token}@" : ''}github.com/#{project_config['origin']}/archive/#{sha}.tar.gz"
+    end
+
+    def bitbucket_url
+      "https://#{bitbucket_token ? "#{bitbucket_username}:#{bitbucket_token}@" : ''}bitbucket.org/#{project_config['origin']}/get/#{sha}.tar.gz"
     end
 
     def app_directory
@@ -40,7 +63,7 @@ module Shiplane
     end
 
     def make_directory
-      FileUtils.mkdir_p build_directory
+      FileUtils.mkdir_p app_directory
     end
 
     def checkout!
@@ -49,18 +72,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} --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 +160,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiplane
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.9
 platform: ruby
 authors:
 - John Epperson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2022-05-29 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.6
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: shiplane_deployers_capistrano_docker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement