envirobly 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cf07e75c65933a5f7c064588ac13a36ee5af3e698fc82f90affc0960bf7d170
-  data.tar.gz: 2f721b799aeb0b2725c92b75b9f1d63b461ad5cfd44d095481aea5c809bd1a2c
+  metadata.gz: aefc0201069c2ebcf4e9038a80904d7e3c6b3217a582572db2536cf9f877367e
+  data.tar.gz: 26b791aa16c6c38613e7ef5b32cc8f1c93eb7342327ed52968e6ee345a9fa12f
 SHA512:
-  metadata.gz: a37f7b8895957e017ddab73d991c1a34b7b50aeff1e491caf923164e3e6c5abe8ddc67900371fc8dc1c7a552c3e2c930e9cb2b92174953531c87fc495debf357
-  data.tar.gz: 43075318aa04c61690e71665823e19da68c2797e1d4534433235a4f3f46254343d454abaa9cd367b641184452df6546ad5f9f447a89e51943dc34084f08202a7
+  metadata.gz: b5dd97f5d8c19a6e3690884f9f9fc9803a338db2048aaf96a9e5502f68f1d70890a1906f5a478dc998b78e39874cce3db600411a71ee615b41276d63dccdf8c4
+  data.tar.gz: fe25c4413c314d7368e7fe6b0b05c44f3919159421b75a6511c1ee5c3ba3174ca8c5e3dc52628cd485556a1ef81e92cb2116549573b3d843ed1f753df3ba337b

data/lib/core_ext.rb

@@ -0,0 +1,113 @@
+class Array
+  alias_method :blank?, :empty?
+
+  def present?
+    !empty?
+  end
+
+  def second
+    self[1]
+  end
+
+  def third
+    self[2]
+  end
+
+  def fourth
+    self[3]
+  end
+
+  def fifth
+    self[4]
+  end
+end
+
+class Object
+  def blank?
+    respond_to?(:empty?) ? !!empty? : false
+  end
+
+  def present?
+    !blank?
+  end
+
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+
+  def present?
+    false
+  end
+end
+
+class FalseClass
+  def blank?
+    true
+  end
+
+  def present?
+    false
+  end
+end
+
+class TrueClass
+  def blank?
+    false
+  end
+
+  def present?
+    true
+  end
+end
+
+class Hash
+  alias_method :blank?, :empty?
+
+  def present?
+    !empty?
+  end
+end
+
+class Symbol
+  alias_method :blank?, :empty?
+
+  def present?
+    !empty?
+  end
+end
+
+class String
+  def blank?
+    strip.empty?
+  end
+
+  def present?
+    !blank?
+  end
+end
+
+class Numeric
+  def blank?
+    false
+  end
+
+  def present?
+    true
+  end
+end
+
+class Time
+  def blank?
+    false
+  end
+
+  def present?
+    true
+  end
+end

data/lib/envirobly/api.rb

@@ -28,7 +28,7 @@ class Envirobly::Api
     response = get_as_json URI(url)
 
     if response.code.to_i == 200
-      return response
+      response
     elsif MAX_RETRIES <= tries
       $stderr.puts "Max retries exhausted while waiting for deployment credentials. Aborting."
       exit 1

data/lib/envirobly/aws/credentials.rb

@@ -5,9 +5,9 @@ class Envirobly::Aws::Credentials
 
   def as_env_vars
     [
-      %{AWS_ACCESS_KEY_ID="#{@params.fetch("access_key_id")}"},
-      %{AWS_SECRET_ACCESS_KEY="#{@params.fetch("secret_access_key")}"},
-      %{AWS_SESSION_TOKEN="#{@params.fetch("session_token")}"}
+      %(AWS_ACCESS_KEY_ID="#{@params.fetch("access_key_id")}"),
+      %(AWS_SECRET_ACCESS_KEY="#{@params.fetch("secret_access_key")}"),
+      %(AWS_SESSION_TOKEN="#{@params.fetch("session_token")}")
     ]
   end
 

data/lib/envirobly/cli/main.rb

@@ -6,6 +6,7 @@ class Envirobly::Cli::Main < Envirobly::Base
 
   desc "deploy ENVIRONMENT", "Deploy to environment identified by name or URL"
   method_option :commit, type: :string, default: "HEAD"
+  method_option :dry_run, type: :boolean, default: false
   def deploy(environment)
     abort_if_aws_cli_is_missing
     Envirobly::Deployment.new environment, options

data/lib/envirobly/config.rb

@@ -6,76 +6,110 @@ class Envirobly::Config
   DIR = ".envirobly"
   PATH = "#{DIR}/project.yml"
 
-  attr_reader :parsing_error
+  attr_reader :errors, :result, :raw
 
   def initialize(commit)
     @commit = commit
-    @parsing_error = nil
-    @project = parse_config_content_at_commit
-
-    if @project
-      transform_env_var_values!
-      append_image_tags!
-    end
+    @errors = []
+    @result = nil
+    @project_url = nil
+    @raw = @commit.file_content PATH
   end
 
   def dig(*args)
-    @project.dig *args
+    @project.dig(*args)
   rescue NoMethodError
     nil
   end
 
-  def to_h
-    @project
-  end
-
-  def parsing_error?
-    !@parsing_error.nil?
+  def compile(environment = nil)
+    @environment = environment
+    return unless @project = parse
+    set_project_url
+    merge_environment_overrides! unless @environment.nil?
+    transform_env_var_values!
+    append_image_tags!
+    @result = @project.slice(:services)
   end
 
-  def path
-    PATH
+  def to_deployment_params
+    {
+      environ: {
+        logical_id: @environment,
+        project_url: @project_url
+      },
+      commit: {
+        ref: @commit.ref,
+        time: @commit.time,
+        message: @commit.message
+      },
+      config: @result,
+      raw_config: @raw
+    }
   end
 
   private
-    def parse_config_content_at_commit
-      YAML.load config_content_at_commit, aliases: true
+    def parse
+      YAML.safe_load @raw, aliases: true, symbolize_names: true
     rescue Psych::Exception => exception
-      @parsing_error = exception.message
+      @errors << exception.message
       nil
     end
 
-    def config_content_at_commit
-      `git show #{@commit.ref}:#{path}`
+    def set_project_url
+      @project_url = dig :remote, :origin
+      if @project_url.blank?
+        @errors << "Missing a `remote.origin` link to project."
+      end
     end
 
     def transform_env_var_values!
-      @project.fetch("services", {}).each do |logical_id, service|
-        service.fetch("env", {}).each do |key, value|
-          if value.is_a?(Hash) && value.has_key?("file")
-            @project["services"][logical_id]["env"][key] = File.read value.fetch("file")
+      @project.fetch(:services, {}).each do |logical_id, service|
+        service.fetch(:env, {}).each do |key, value|
+          if value.is_a?(Hash) && value.has_key?(:file)
+            @project[:services][logical_id][:env][key] = @commit.file_content(value.fetch(:file)).strip
           end
         end
       end
     end
 
     NON_BUILDABLE_TYPES = %w[ postgres mysql valkey ]
+    BUILD_DEFAULTS = {
+      dockerfile: "Dockerfile",
+      build_context: "."
+    }
     def append_image_tags!
-      @project.fetch("services", {}).each do |logical_id, service|
-        next if NON_BUILDABLE_TYPES.include?(service["type"]) || service["image_uri"]
+      @project.fetch(:services, {}).each do |logical_id, service|
+        next if NON_BUILDABLE_TYPES.include?(service[:type]) || service[:image].present?
+        checksums = []
 
-        dockerfile = service.fetch("dockerfile", "Dockerfile")
-        build_context = service.fetch("build_context", ".")
+        BUILD_DEFAULTS.each do |attribute, default|
+          value = service.fetch(attribute, default)
+          checksum = @commit.objects_with_checksum_at value
+          if checksum.empty?
+            @errors << "Service `#{logical_id}` specifies `#{attribute}` as `#{value}` which doesn't exist in this commit."
+          else
+            checksums << checksum
+          end
+        end
 
-        @project["services"][logical_id]["image_tag"] = Digest::SHA1.hexdigest [
-          git_path_checksums_at_commit(dockerfile),
-          git_path_checksums_at_commit(build_context)
-        ].to_json
+        if checksums.size == 2
+          @project[:services][logical_id][:image_tag] = Digest::SHA1.hexdigest checksums.to_json
+        end
       end
     end
 
-    def git_path_checksums_at_commit(path)
-      `git ls-tree #{@commit.ref} --format='%(objectname) %(path)' #{path}`.
-        lines.reject { _1.split(" ").last == DIR }
+    def merge_environment_overrides!
+      return unless services = @project.dig(:environments, @environment.to_sym)
+      services.each do |logical_id, service|
+        service.each do |attribute, value|
+          if value.is_a?(Hash) && @project[:services][logical_id][attribute].is_a?(Hash)
+            @project[:services][logical_id][attribute].merge! value
+            @project[:services][logical_id][attribute].compact!
+          else
+            @project[:services][logical_id][attribute] = value
+          end
+        end
+      end
     end
 end

data/lib/envirobly/deployment.rb

@@ -1,71 +1,49 @@
 class Envirobly::Deployment
-  URL_MATCHER = /^https:\/\/envirobly\.(test|com)\/(\d+)\/environs\/(\d+)$/
-
   def initialize(environment, options)
-    @commit = Envirobly::Git::Commit.new options.commit
+    commit = Envirobly::Git::Commit.new options.commit
 
-    unless @commit.exists?
+    unless commit.exists?
       $stderr.puts "Commit #{options.commit} doesn't exist in this repository. Aborting."
       exit 1
     end
 
-    config = Envirobly::Config.new(@commit)
-    if config.parsing_error?
-      $stderr.puts "Error while parsing #{config.path}"
-      $stderr.puts config.parsing_error
+    config = Envirobly::Config.new(commit)
+    config.compile(environment)
+
+    if config.errors.any?
+      $stderr.puts "Errors found while parsing #{Envirobly::Config::PATH}:"
+      $stderr.puts
+      config.errors.each do |error|
+        $stderr.puts "  - #{error}"
+      end
+      $stderr.puts
+      $stderr.puts "Please fix these, commit the changes and try again."
       exit 1
     end
 
-    params = {
-      environ: {
-        logical_id: environment
-      },
-      commit: {
-        ref: @commit.ref,
-        time: @commit.time,
-        message: @commit.message
-      },
-      config: config.to_h
-    }
+    params = config.to_deployment_params
 
     puts "Deployment config:"
     puts params.to_yaml
 
-    unless environment =~ URL_MATCHER
-      if project_url = config.dig("remote", "origin")
-        params[:environ][:project_url] = project_url
-      else
-        $stderr.puts "{remote.origin} is required in .envirobly/project.yml"
-        exit 1
-      end
-    end
+    exit if options.dry_run?
 
-    @api = Envirobly::Api.new
-    response = @api.create_deployment params
+    api = Envirobly::Api.new
+    response = api.create_deployment params
     deployment_url = response.object.fetch("url")
-    response = @api.get_deployment_with_delay_and_retry deployment_url
-    @credentials = Envirobly::Aws::Credentials.new response.object.fetch("credentials")
-    @bucket = response.object.fetch("bucket")
+    response = api.get_deployment_with_delay_and_retry deployment_url
+    credentials = Envirobly::Aws::Credentials.new response.object.fetch("credentials")
+    bucket = response.object.fetch("bucket")
 
     puts "Uploading build context, please wait..."
-    unless archive_commit_and_upload
+    unless commit.archive_and_upload(bucket:, credentials:)
       $stderr.puts "Error exporting build context. Aborting."
       exit 1
     end
 
     puts "Build context uploaded."
-    @api.put_as_json deployment_url
+    api.put_as_json deployment_url
 
     # TODO: Output URL to watch the deployment progress
   end
-
-  private
-    def archive_uri
-      "s3://#{@bucket}/#{@commit.ref}.tar.gz"
-    end
-
-    def archive_commit_and_upload
-      `git archive --format=tar.gz #{@commit.ref} | #{@credentials.as_inline_env_vars} aws s3 cp - #{archive_uri}`
-      $?.success?
-    end
 end

data/lib/envirobly/git/commit.rb

@@ -1,23 +1,57 @@
 require "time"
+require "open3"
 
 class Envirobly::Git::Commit
-  def initialize(ref)
+  def initialize(ref, working_dir: Dir.getwd)
     @ref = ref
+    @working_dir = working_dir
   end
 
   def exists?
-    `git cat-file -t #{@ref}`.strip == "commit"
+    run(%(cat-file -t #{@ref})).strip == "commit"
   end
 
   def ref
-    @normalized_ref ||= `git rev-parse #{@ref}`.strip
+    @normalized_ref ||= run(%(rev-parse #{@ref})).strip
   end
 
   def message
-    `git log #{@ref} -n1 --pretty=%B`.strip
+    run(%(log #{@ref} -n1 --pretty=%B)).strip
   end
 
   def time
-    Time.parse `git log #{@ref} -n1 --date=iso --pretty=format:"%ad"`
+    Time.parse run(%(log #{@ref} -n1 --date=iso --pretty=format:"%ad"))
   end
+
+  def file_content(path)
+    run %(show #{@ref}:#{path})
+  end
+
+  def objects_with_checksum_at(path)
+    run(%{ls-tree #{@ref} --format='%(objectname) %(path)' #{path}}).lines.map(&:chomp).
+      reject { _1.split(" ").last == Envirobly::Config::DIR }
+  end
+
+  def archive_and_upload(bucket:, credentials:)
+    `GIT_WORK_TREE="#{@working_dir}" GIT_DIR="#{@working_dir}/.git" git archive --format=tar.gz #{ref} | #{credentials.as_inline_env_vars} aws s3 cp - #{archive_uri(bucket)}`
+    $?.success?
+  end
+
+  private
+    def run(cmd)
+      @stdout = @stderr = @exit_code = @success = nil
+      full_cmd = %(GIT_WORK_TREE="#{@working_dir}" GIT_DIR="#{@working_dir}/.git" git #{cmd})
+      Open3.popen3(full_cmd) do |stdin, stdout, stderr, thread|
+        stdin.close
+        @stdout = stdout.read
+        @stderr = stderr.read
+        @exit_code = thread.value.exitstatus
+        @success = thread.value.success?
+      end
+      @stdout
+    end
+
+    def archive_uri(bucket)
+      "s3://#{bucket}/#{ref}.tar.gz"
+    end
 end

data/lib/envirobly/version.rb

@@ -1,3 +1,3 @@
 module Envirobly
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/envirobly.rb

@@ -1,10 +1,10 @@
 module Envirobly
 end
 
-# require "active_support"
-# require "active_support/core_ext"
 require "zeitwerk"
+require "core_ext"
 
 loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/core_ext.rb")
 loader.setup
 loader.eager_load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envirobly
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Robert Starsi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,19 +39,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
+        version: 0.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: klevo@klevo.sk
 executables:
@@ -61,6 +117,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - bin/envirobly
+- lib/core_ext.rb
 - lib/envirobly.rb
 - lib/envirobly/access_token.rb
 - lib/envirobly/api.rb
@@ -93,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Envirobly command line interface