envirobly 0.7.2 → 1.0.0

data/lib/envirobly/config.rb

@@ -1,208 +1,38 @@
-require "yaml"
-require "json"
-require "digest"
+require "dotenv"
 
 class Envirobly::Config
   DIR = ".envirobly"
-  PATH = "#{DIR}/project.yml"
+  BASE = "deploy.yml"
+  ENV_VARS = "env"
+  OVERRIDES_PATTERN = /deploy\.([a-z0-9\-_]+)\.yml/i
 
-  attr_reader :errors, :result, :raw
-
-  def initialize(commit)
-    @commit = commit
-    @errors = []
-    @result = {}
-    @project_url = nil
-    @raw = @commit.file_content PATH
-    @project = parse
-  end
-
-  def dig(*args)
-    @project.dig(*args)
-  rescue NoMethodError
-    nil
-  end
-
-  def validate
-    return unless @project
-    validate_top_level_keys
-    validate_services @project.fetch(:services)
-    validate_environments
-  end
-
-  def compile(environment = nil)
-    return unless @project
-    @environment = environment
-    @result = @project.slice(:services)
-    set_project_url
-    merge_environment_overrides! unless @environment.nil?
-    append_image_tags!
+  def initialize(dir = DIR)
+    @dir = Pathname.new dir
   end
 
-  def to_deployment_params
+  def to_params
     {
-      environ: {
-        name: @environment,
-        project_url: @project_url
-      },
-      commit: {
-        ref: @commit.ref,
-        time: @commit.time,
-        message: @commit.message
-      },
-      config: @result,
-      raw_config: @raw
+      configs:,
+      env_vars:
     }
   end
 
   private
-    def parse
-      YAML.safe_load @raw, aliases: true, symbolize_names: true
-    rescue Psych::Exception => exception
-      @errors << exception.message
-      nil
-    end
-
-    def set_project_url
-      @project_url = dig :project
-    end
-
-    NON_BUILDABLE_TYPES = %w[ postgres mysql valkey ]
-    BUILD_DEFAULTS = {
-      dockerfile: [ "Dockerfile", :file_exists? ],
-      build_context: [ ".", :dir_exists? ]
-    }
-    def append_image_tags!
-      @result[:services].each do |name, service|
-        next if NON_BUILDABLE_TYPES.include?(service[:type]) || service[:image].present?
-        checksums = []
-
-        BUILD_DEFAULTS.each do |attribute, options|
-          value = service.fetch(attribute, options.first)
-          if @commit.public_send(options.second, value)
-            checksums << @commit.objects_with_checksum_at(value)
-          end
-        end
-
-        if checksums.size == 2
-          @result[:services][name][:image_tag] = Digest::SHA1.hexdigest checksums.to_json
-        end
-      end
-    end
-
-    def merge_environment_overrides!
-      return unless services = @project.dig(:environments, @environment.to_sym)
-      services.each do |name, service|
-        service.each do |attribute, value|
-          if value.is_a?(Hash) && @result[:services][name][attribute].is_a?(Hash)
-            @result[:services][name][attribute].merge! value
-            @result[:services][name][attribute].compact!
-          else
-            @result[:services][name][attribute] = value
-          end
-        end
-      end
-    end
-
-    VALID_TOP_LEVEL_KEYS = %i[ project services environments ]
-    def validate_top_level_keys
-      unless @project.is_a?(Hash)
-        @errors << "Config doesn't contain a top level hash structure."
-        return
-      end
+    def configs
+      Dir.entries(@dir).map do |file|
+        path = File.join(@dir, file)
 
-      @errors << "Missing `project: <url>` top level attribute." if @project[:project].blank?
+        next unless File.file?(path) && config_file?(file)
 
-      @project.keys.each do |key|
-        unless VALID_TOP_LEVEL_KEYS.include?(key)
-          @errors << "Top level key `#{key}` is not allowed. Allowed keys: #{VALID_TOP_LEVEL_KEYS.map{ "`#{_1}`" }.join(", ")}."
-        end
-      end
+        [ "#{DIR}/#{file}", File.read(path) ]
+      end.compact.to_h
     end
 
-    VALID_SERVICE_KEYS = %i[
-      type
-      image
-      build
-      engine_version
-      instance_type
-      min_instances
-      max_instances
-      volume_size
-      volume_mount
-      dockerfile
-      build_context
-      command
-      release_command
-      env
-      health_check
-      http
-      private
-      aliases
-    ]
-    NAME_FORMAT = /\A[a-z0-9\-_\.\/]+\z/i
-    BUILD_VALUE_FORMAT = /\Av[\d+]\z/
-    def validate_services(services)
-      unless services.is_a?(Hash)
-        @errors << "`services` key must be a hash."
-        return
-      end
-
-      services.each do |name, service|
-        unless name =~ NAME_FORMAT
-          @errors << "`#{name}` is not a valid service name. Use aplhanumeric characters, dash, underscore, slash or dot."
-        end
-
-        unless service.is_a?(Hash)
-          @errors << "Service `#{name}` must be a hash."
-          next
-        end
-
-        service.each do |attribute, value|
-          unless VALID_SERVICE_KEYS.include?(attribute)
-            @errors << "Service `#{name}` attribute `#{attribute}` is not a valid attribute."
-          end
-
-          if attribute == :build
-            unless value =~ BUILD_VALUE_FORMAT
-              @errors << "Service `#{name}` attribute `#{attribute}` format needs to be a number prefixed with letter \"v\", for example \"v1\"."
-            end
-          end
-        end
-
-        BUILD_DEFAULTS.each do |attribute, options|
-          value = service.fetch(attribute, options.first)
-          unless @commit.public_send(options.second, value)
-            @errors << "Service `#{name}` specifies `#{attribute}` as `#{value}` which doesn't exist in this commit."
-          end
-        end
-
-        service.fetch(:env, {}).each do |key, value|
-          if value.is_a?(Hash) && value.has_key?(:file)
-            unless @commit.file_exists?(value.fetch(:file))
-              @errors << "Environment variable `#{key}` referring to a file `#{value.fetch(:file)}` doesn't exist in this commit."
-            end
-          end
-        end
-      end
+    def env_vars
+      Dotenv.parse @dir.join(ENV_VARS)
     end
 
-    def validate_environments
-      return unless @project.has_key?(:environments)
-
-      environments = @project.fetch :environments, nil
-
-      unless environments.is_a?(Hash)
-        @errors << "`environments` key must be a hash."
-        return
-      end
-
-      environments.each do |environment, services|
-        unless environment =~ NAME_FORMAT
-          @errors << "`#{environment}` is not a valid environment name. Use aplhanumeric characters, dash, underscore, slash or dot."
-        end
-
-        validate_services services
-      end
+    def config_file?(file)
+      file == BASE || file.match?(OVERRIDES_PATTERN)
     end
 end

data/lib/envirobly/default.rb

@@ -0,0 +1,47 @@
+class Envirobly::Default
+  attr_accessor :shell
+
+  def self.key = "url"
+
+  def initialize(shell: nil)
+    @path = File.join Envirobly::Config::DIR, "defaults", self.class.file
+    @shell = shell
+  end
+
+  def id
+    if File.exist?(@path)
+      content = YAML.safe_load_file(@path)
+
+      if content[self.class.key] =~ self.class.regexp
+        return cast_id($1)
+      end
+    end
+
+    nil
+  end
+
+  def save(url)
+    unless url =~ self.class.regexp
+      raise ArgumentError, "'#{url}' must match #{self.class.regexp}"
+    end
+
+    FileUtils.mkdir_p(File.dirname(@path))
+    content = YAML.dump({ self.class.key => url })
+    File.write(@path, content)
+  end
+
+  def save_if_none(url)
+    return if id.present?
+
+    save(url)
+  end
+
+  def require_if_none
+    id || require_id
+  end
+
+  private
+    def cast_id(value)
+      value.to_i
+    end
+end

data/lib/envirobly/defaults/account.rb

@@ -0,0 +1,46 @@
+class Envirobly::Defaults::Account < Envirobly::Default
+  include Envirobly::Colorize
+
+  def self.file = "account.yml"
+  def self.regexp = /accounts\/(\d+)/
+
+  def require_id
+    api = Envirobly::Api.new
+    accounts = api.list_accounts
+
+    if accounts.object.blank?
+      shell.say_error "Please connect an AWS account to your Envirobly account first."
+      exit 1
+    end
+
+    account = accounts.object.first
+    id = account["id"]
+
+    if accounts.object.size > 1
+      puts "Choose default account to deploy this project to:"
+
+      data = [ [ "ID", "Name", "AWS number", "URL" ] ] +
+        accounts.object.pluck("id", "name", "aws_id", "url")
+
+      shell.print_table data, borders: true
+
+      limited_to = accounts.object.pluck("id").map(&:to_s)
+
+      begin
+        id = shell.ask("Type in the account ID:", limited_to:).to_i
+      rescue Interrupt
+        shell.say_error "Cancelled"
+        exit
+      end
+
+      account = accounts.object.find { |a| a["id"] == id }
+    end
+
+    save account["url"]
+
+    shell.say "Account ##{id} set as project default "
+    shell.say green_check
+
+    id
+  end
+end

data/lib/envirobly/defaults/project.rb

@@ -0,0 +1,4 @@
+class Envirobly::Defaults::Project < Envirobly::Default
+  def self.file = "project.yml"
+  def self.regexp = /projects\/(\d+)/
+end

data/lib/envirobly/defaults/region.rb

@@ -0,0 +1,45 @@
+class Envirobly::Defaults::Region < Envirobly::Default
+  include Envirobly::Colorize
+
+  def self.file = "region.yml"
+  def self.regexp = /([a-z0-9\-)]+)/
+  def self.key = "code"
+
+  def require_id
+    api = Envirobly::Api.new
+    response = api.list_regions
+
+    shell.say "Choose default project region to deploy to:"
+    shell.print_table [ [ "Name", "Location", "Group" ] ] +
+      response.object.pluck("code", "title", "group_title"), borders: true
+
+    code = nil
+    limited_to = response.object.pluck("code")
+
+    while code.nil?
+      begin
+        code = shell.ask("Type in the region name:", default: "us-east-1")
+      rescue Interrupt
+        shell.say_error "Cancelled"
+        exit
+      end
+
+      unless code.in?(limited_to)
+        shell.say_error "'#{code}' is not a supported region, please try again"
+        code = nil
+      end
+    end
+
+    save code
+
+    shell.say "Region '#{id}' set as project default "
+    shell.say green_check
+
+    id
+  end
+
+  private
+    def cast_id(value)
+      value
+    end
+end

data/lib/envirobly/defaults.rb

@@ -0,0 +1,2 @@
+module Envirobly::Defaults
+end

data/lib/envirobly/deployment.rb

@@ -1,50 +1,99 @@
+require "yaml"
+
 class Envirobly::Deployment
-  def initialize(environment, options)
-    commit = Envirobly::Git::Commit.new options.commit
+  include Envirobly::Colorize
+
+  def initialize(environ_name:, commit:, account_id:, project_name:, project_id:, region:, shell:)
+    @environ_name = environ_name
+    @commit = commit
+    @config = Envirobly::Config.new
+    @default_account = Envirobly::Defaults::Account.new(shell:)
+    @default_project = Envirobly::Defaults::Project.new(shell:)
+    @default_region = Envirobly::Defaults::Region.new(shell:)
 
-    unless commit.exists?
-      $stderr.puts "Commit #{options.commit} doesn't exist in this repository. Aborting."
-      exit 1
+    if account_id.blank?
+      account_id = @default_account.require_if_none
     end
 
-    config = Envirobly::Config.new(commit)
-    config.validate
+    if project_id.blank? && project_name.blank?
+      project_id = @default_project.id
 
-    if config.errors.any?
-      $stderr.puts "Errors found while parsing #{Envirobly::Config::PATH}:"
-      $stderr.puts
-      config.errors.each do |error|
-        $stderr.puts "  - #{error}"
+      if project_id.nil?
+        project_name = File.basename(Dir.pwd)
       end
-      $stderr.puts
-      $stderr.puts "Please fix these, commit the changes and try again."
-      exit 1
     end
 
-    config.compile(environment)
-    params = config.to_deployment_params
+    if region.blank?
+      region = @default_region.require_if_none
+    end
+
+    @params = {
+      account: {
+        id: account_id
+      },
+      project: {
+        id: project_id,
+        name: project_name,
+        region:
+      },
+      deployment: {
+        environ_name:,
+        commit_ref: @commit.ref,
+        commit_time: @commit.time,
+        commit_message: @commit.message,
+        object_tree_checksum: @commit.object_tree_checksum,
+        **@config.to_params
+      }
+    }
+  end
 
-    puts "Deployment config:"
-    puts params.to_yaml
+  def perform(dry_run:)
+    puts [ "Deploying commit", yellow(@commit.short_ref), faint("→"), green(@environ_name) ].join(" ")
+    puts
+    puts "    #{@commit.message}"
+    puts
 
-    exit if options.dry_run?
+    if dry_run
+      puts YAML.dump(@params)
+      return
+    end
 
+    # Create deployment
     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")
-
-    puts "Uploading build context, please wait..."
-    unless commit.archive_and_upload(bucket:, credentials:).success?
-      $stderr.puts "Error exporting build context. Aborting."
-      exit 1
+
+    Envirobly::Duration.measure do
+      response = api.create_deployment @params
+
+      unless response.success?
+        display_config_errors response.object.fetch("errors")
+        exit 1
+      end
+
+      print "Preparing project..."
+
+      @default_account.save_if_none response.object.fetch("account_url")
+      @default_project.save_if_none response.object.fetch("project_url")
+      @default_region.save_if_none response.object.fetch("region")
+
+      # Fetch credentials for build context upload
+      @deployment_url = response.object.fetch("url")
+      @credentials_response = api.get_deployment_with_delay_and_retry @deployment_url
     end
 
-    puts "Build context uploaded."
-    api.put_as_json deployment_url
+    credentials = @credentials_response.object.fetch("credentials")
+    region = @credentials_response.object.fetch("region")
+    bucket = @credentials_response.object.fetch("bucket")
+    watch_deployment_url = @credentials_response.object.fetch("deployment_url")
+
+    Envirobly::Duration.measure do
+      # Upload build context
+      s3 = Envirobly::Aws::S3.new(bucket:, region:, credentials:)
+      s3.push @commit
+
+      # Perform deployment
+      api.put_as_json @deployment_url
+    end
 
-    # TODO: Output URL to watch the deployment progress
+    puts "Follow at #{watch_deployment_url}"
   end
 end

data/lib/envirobly/duration.rb

@@ -0,0 +1,36 @@
+require "benchmark"
+
+class Envirobly::Duration
+  class << self
+    include Envirobly::Colorize
+
+    def measure(message = nil)
+      measurement = Benchmark.measure do
+        yield
+      end
+
+      duration = format_duration(measurement)
+
+      if message.nil?
+        puts [ "", green_check, faint(duration) ].join(" ")
+      else
+        puts sprintf(message, duration)
+      end
+    end
+
+    def format_duration(tms)
+      ms = (tms.real * 1000).to_i
+
+      if ms >= 60_000
+        minutes = ms / 60_000
+        seconds = (ms % 60_000) / 1000
+        sprintf("%dm%ds", minutes, seconds)
+      elsif ms >= 1000
+        seconds = ms / 1000
+        sprintf("%ds", seconds)
+      else
+        sprintf("%dms", ms)
+      end
+    end
+  end
+end

data/lib/envirobly/git/commit.rb

@@ -1,10 +1,15 @@
 require "time"
 require "open3"
 
-class Envirobly::Git::Commit
+class Envirobly::Git::Commit < Envirobly::Git
+  EXECUTABLE_FILE_MODE = "100755"
+  SYMLINK_FILE_MODE = "120000"
+
+  attr_reader :working_dir
+
   def initialize(ref, working_dir: Dir.getwd)
     @ref = ref
-    @working_dir = working_dir
+    super working_dir
   end
 
   def exists?
@@ -15,6 +20,10 @@ class Envirobly::Git::Commit
     @normalized_ref ||= git(%(rev-parse #{@ref})).stdout.strip
   end
 
+  def short_ref
+    @short_ref ||= ref[0..6]
+  end
+
   def message
     git(%(log #{@ref} -n1 --pretty=%B)).stdout.strip
   end
@@ -36,25 +45,35 @@ class Envirobly::Git::Commit
     git(%(show #{@ref}:#{path})).stdout
   end
 
-  def objects_with_checksum_at(path)
-    git(%{ls-tree #{@ref} --format='%(objectname) %(path)' #{path}}).stdout.lines.map(&:chomp).
-      reject { _1.split(" ").last == Envirobly::Config::DIR }
-  end
+  def object_tree(ref: @ref, chdir: @working_dir)
+    @object_tree ||= begin
+      objects = {}
+      objects[chdir] = []
 
-  def archive_and_upload(bucket:, credentials:)
-    git(%(archive --format=tar.gz #{ref} | #{credentials.as_inline_env_vars} aws s3 cp - #{archive_uri(bucket)}))
-  end
+      git(%(ls-tree -r #{ref}), chdir:).stdout.lines.each do |line|
+        mode, type, object_hash, path = line.split(/\s+/)
+
+        next if path.start_with?("#{Envirobly::Config::DIR}/")
 
-  private
-    OUTPUT = Struct.new :stdout, :stderr, :exit_code, :success?
-    def git(cmd)
-      Open3.popen3("git #{cmd}", chdir: @working_dir) do |stdin, stdout, stderr, thread|
-        stdin.close
-        OUTPUT.new stdout.read, stderr.read, thread.value.exitstatus, thread.value.success?
+        if type == "commit"
+          objects.merge! object_tree(ref: object_hash, chdir: File.join(chdir, path))
+        else
+          objects[chdir] << [ mode, type, object_hash, path ]
+        end
       end
-    end
 
-    def archive_uri(bucket)
-      "s3://#{bucket}/#{ref}.tar.gz"
+      objects
     end
+  end
+
+  def object_tree_checksum
+    digestable = object_tree.values.flatten.to_json
+    @object_tree_checksum ||= Digest::SHA256.hexdigest(digestable)
+  end
+
+  # @deprecated
+  def objects_with_checksum_at(path)
+    git(%{ls-tree #{@ref} --format='%(objectname) %(path)' #{path}}).stdout.lines.map(&:chomp).
+      reject { _1.split(" ").last == Envirobly::Config::DIR }
+  end
 end

data/lib/envirobly/git.rb

@@ -1,2 +1,17 @@
-module Envirobly::Git
+class Envirobly::Git
+  def initialize(working_dir = Dir.getwd)
+    @working_dir = working_dir
+  end
+
+  OUTPUT = Struct.new :stdout, :stderr, :exit_code, :success?
+  def git(cmd, chdir: @working_dir)
+    Open3.popen3("git #{cmd}", chdir:) do |stdin, stdout, stderr, thread|
+      stdin.close
+      OUTPUT.new stdout.read, stderr.read, thread.value.exitstatus, thread.value.success?
+    end
+  end
+
+  def current_branch
+    git("branch --show-current").stdout.strip
+  end
 end

data/lib/envirobly/version.rb

@@ -1,3 +1,3 @@
 module Envirobly
-  VERSION = "0.7.2"
+  VERSION = "1.0.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