envirobly 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca86599ff3741799e0a3faf9d3386c3c937713b15c8fb063dc6c647879eacfd1
-  data.tar.gz: d22ece59c009474e6f3bf465e96452eddfc344c344e1a64e4255c88c828d7e12
+  metadata.gz: a2750aa4a83c0407fbba1c7db3aa5b7cebaa6ea08fd2112064a4c6c5d88aad4c
+  data.tar.gz: 464b4a65da73a81d6a62c1f2fa35f4dd927bd790e16cc3f0f58e3d1048e0d87c
 SHA512:
-  metadata.gz: 341a285db112636480ec428f8647ecddc573ce063e64a57e0a79f289bebad4567397c428179d0b109e2e9b443d1e0853f9a4edadbae7280744b42e79381ee834
-  data.tar.gz: efed0f09a1fa8a33095d4a838c04a8c2657b7673e986796bc5df68f962e181ad7db975678532a31e2f86f2b2b9efe3ba2fb823b0a7582a91bc5adfc37c2d7253
+  metadata.gz: '09321732787c09ee02ca9c4071fb916930db737f07dee8a2cd0ffe482620f3f61586a01d796df4a8452b5c7e2b4f6186e8f9ad7ad9feb633f2f5135c5ce7aefb'
+  data.tar.gz: 44513ce52f34fef1310f54095589dec1ab05a0233c1a16f77309ebc9c3cbce2cacf1dea70b01a63fafeab26ae7005de6b9ecb46e8d6b25aa6d938d8e939bcc81

data/lib/envirobly/cli/main.rb

@@ -4,6 +4,25 @@ class Envirobly::Cli::Main < Envirobly::Base
     puts Envirobly::VERSION
   end
 
+  desc "validate", "Validates config"
+  def validate
+    commit = Envirobly::Git::Unstaged.new
+    config = Envirobly::Config.new(commit)
+    config.validate
+
+    if config.errors.any?
+      puts "Issues found validating `#{Envirobly::Config::PATH}`:"
+      puts
+      config.errors.each_with_index do |error, index|
+        puts "  #{index + 1}. #{error}"
+      end
+      puts
+      exit 1
+    else
+      puts "All checks pass."
+    end
+  end
+
   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
@@ -15,7 +34,9 @@ class Envirobly::Cli::Main < Envirobly::Base
   desc "set_access_token TOKEN", "Save and use an access token generated at Envirobly"
   def set_access_token
     token = ask("Access Token:", echo: false).strip
-    if token == ""
+
+    if token.blank?
+      $stderr.puts
       $stderr.puts "Token can't be empty."
       exit 1
     end

data/lib/envirobly/config.rb

@@ -11,9 +11,10 @@ class Envirobly::Config
   def initialize(commit)
     @commit = commit
     @errors = []
-    @result = nil
+    @result = {}
     @project_url = nil
     @raw = @commit.file_content PATH
+    @project = parse
   end
 
   def dig(*args)
@@ -22,20 +23,27 @@ class Envirobly::Config
     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
-    return unless @project = parse
+    @result = @project.slice(:services)
     set_project_url
     merge_environment_overrides! unless @environment.nil?
     transform_env_var_values!
     append_image_tags!
-    @result = @project.slice(:services)
   end
 
   def to_deployment_params
     {
       environ: {
-        logical_id: @environment,
+        name: @environment,
         project_url: @project_url
       },
       commit: {
@@ -57,17 +65,14 @@ class Envirobly::Config
     end
 
     def set_project_url
-      @project_url = dig :remote, :origin
-      if @project_url.blank?
-        @errors << "Missing a `remote.origin` link to project."
-      end
+      @project_url = dig :project
     end
 
     def transform_env_var_values!
-      @project.fetch(:services, {}).each do |logical_id, service|
+      @result[:services].each do |name, 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
+            @result[:services][name][:env][key] = @commit.file_content(value.fetch(:file)).strip
           end
         end
       end
@@ -75,41 +80,128 @@ class Envirobly::Config
 
     NON_BUILDABLE_TYPES = %w[ postgres mysql valkey ]
     BUILD_DEFAULTS = {
-      dockerfile: "Dockerfile",
-      build_context: "."
+      dockerfile: [ "Dockerfile", :file_exists? ],
+      build_context: [ ".", :dir_exists? ]
     }
     def append_image_tags!
-      @project.fetch(:services, {}).each do |logical_id, service|
+      @result[:services].each do |name, service|
         next if NON_BUILDABLE_TYPES.include?(service[:type]) || service[:image].present?
         checksums = []
 
-        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
+        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
-          @project[:services][logical_id][:image_tag] = Digest::SHA1.hexdigest checksums.to_json
+          @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 |logical_id, service|
+      services.each do |name, 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!
+          if value.is_a?(Hash) && @result[:services][name][attribute].is_a?(Hash)
+            @result[:services][name][attribute].merge! value
+            @result[:services][name][attribute].compact!
           else
-            @project[:services][logical_id][attribute] = value
+            @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
+
+      @errors << "Missing `project: <url>` top level attribute." if @project[:project].blank?
+
+      @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
+    end
+
+    VALID_SERVICE_KEYS = %i[
+      type
+      image
+      engine_version
+      instance_type
+      volume_size
+      volume_mount
+      dockerfile
+      build_context
+      command
+      env
+      health_check
+      private
+      aliases
+    ]
+    NAME_FORMAT = /\A[a-z0-9\-_]+\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. Allowed characters: a-z, 0-9, -, _"
+        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
         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
+    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. Allowed characters: a-z, 0-9, -, _"
+        end
+
+        validate_services services
       end
     end
 end

data/lib/envirobly/deployment.rb

@@ -8,7 +8,7 @@ class Envirobly::Deployment
     end
 
     config = Envirobly::Config.new(commit)
-    config.compile(environment)
+    config.validate
 
     if config.errors.any?
       $stderr.puts "Errors found while parsing #{Envirobly::Config::PATH}:"
@@ -21,6 +21,7 @@ class Envirobly::Deployment
       exit 1
     end
 
+    config.compile(environment)
     params = config.to_deployment_params
 
     puts "Deployment config:"

data/lib/envirobly/git/commit.rb

@@ -23,6 +23,15 @@ class Envirobly::Git::Commit
     Time.parse git(%(log #{@ref} -n1 --date=iso --pretty=format:"%ad")).stdout
   end
 
+  def file_exists?(path)
+    git(%(cat-file -t #{@ref}:#{path})).stdout.strip == "blob"
+  end
+
+  def dir_exists?(path)
+    suffix = path.end_with?("/") ? nil : "/"
+    git(%(cat-file -t #{@ref}:#{path}#{suffix})).stdout.strip == "tree"
+  end
+
   def file_content(path)
     git(%(show #{@ref}:#{path})).stdout
   end

data/lib/envirobly/git/unstaged.rb

@@ -0,0 +1,17 @@
+class Envirobly::Git::Unstaged < Envirobly::Git::Commit
+  def initialize(working_dir: Dir.getwd)
+    @working_dir = working_dir
+  end
+
+  def file_exists?(path)
+    File.exist? path
+  end
+
+  def dir_exists?(path)
+    Dir.exist? path
+  end
+
+  def file_content(path)
+    File.read path
+  end
+end

data/lib/envirobly/version.rb

@@ -1,3 +1,3 @@
 module Envirobly
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envirobly
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Robert Starsi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -130,6 +130,7 @@ files:
 - lib/envirobly/deployment.rb
 - lib/envirobly/git.rb
 - lib/envirobly/git/commit.rb
+- lib/envirobly/git/unstaged.rb
 - lib/envirobly/version.rb
 homepage: https://github.com/envirobly/envirobly-cli
 licenses: