uffizzi-cli 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c73f738c3d7c7c9773f36b0c500300e91faf276e7f939ecdfb596a0dc5546145
-  data.tar.gz: dda472028a13e9504fb0b387863eb16892ed2d3b01efb1ee7f99f0fd1290685c
+  metadata.gz: 5aa0242e35791e35a51a850316bb18a97f1651aa345c64ee05264cb6b7faa702
+  data.tar.gz: bc9a8c8176c2969edf8728be715a0d45c38dab6a3d0e6da37c8022e04d9e8e24
 SHA512:
-  metadata.gz: 8f50a0fc27ea11fbc497968a9861679b24b67e41b430f518eae6c59be9b9fc698c7142213a7c98d3ffe323ce71d5c9dc5eac19031ee9e55dc2d4628abe2ed4e6
-  data.tar.gz: e7980d0ff7b013e1e7aec8872afcd20c50570689dd43d03720d6a096138a0894ce6932f5166ce564befd901d5553bbb80fdb5c8667f7a1605e6685b5179ae28e
+  metadata.gz: 993d29e07d6fe739cd3ab82383a948ed2d251f7b00662b02b87cd3a9b1b556ee2e1ed16f224f857ce0689ac64b84d02b74aa711f24f477d546d1f13c378938a1
+  data.tar.gz: d91befdb081561d8395800f672918518397a70734abc3ff1ec2b57faa0180063f808722afc14de85e056507972d97eb4ef774614d1dd72a54311f5f34629abf0

data/lib/uffizzi/services/compose_file_service.rb

@@ -3,30 +3,45 @@
 require 'psych'
 require 'pathname'
 require 'base64'
+require 'minitar'
+require 'zlib'
+require 'uffizzi/services/project_service'
+require 'uffizzi/services/volume_parser_service'
 
 class ComposeFileService
+  MAX_HOST_VOLUME_GZIP_FILE_SIZE = 1024 * 900
+  DEPENDENCY_CONFIG_USE_KIND = :config_map
+  DEPENDENCY_VOLUME_USE_KIND = :volume
+
   class << self
-    def parse(compose_content, compose_file_path)
+    def parse(compose_content, compose_file_dir)
       compose_data = parse_compose_content_to_object(compose_content)
 
-      env_files = prepare_services_env_files(compose_data['services']).flatten.uniq
-      config_files = fetch_configs(compose_data['configs'])
-      prepare_dependencies(env_files, config_files, compose_file_path)
+      services = compose_data['services']
+      env_files_paths = prepare_env_files_paths(services).flatten.uniq
+      config_files_paths = prepare_config_files_paths(compose_data['configs'])
+      host_volumes_paths = prepare_host_volumes_paths(services)
+      prepare_dependencies(compose_file_dir, env_files_paths, config_files_paths, host_volumes_paths)
     end
 
     private
 
-    def prepare_dependencies(env_files, config_files, compose_file_path)
-      prepare_dependency_files_data(env_files + config_files, compose_file_path)
+    def prepare_dependencies(compose_file_dir, env_files_paths, config_files_paths, host_volumes_paths)
+      config_files_attrs = prepare_dependency_configs_files(env_files_paths + config_files_paths, compose_file_dir)
+      host_volumes_attrs = prepare_dependency_host_volumes_files(host_volumes_paths, compose_file_dir)
+
+      config_files_attrs + host_volumes_attrs
     end
 
-    def prepare_dependency_files_data(dependency_files, compose_file_path)
-      dependency_files.map do |dependency_file|
-        dependency_file_data = Psych.load(File.read("#{compose_file_path}/#{dependency_file}"))
+    def prepare_dependency_configs_files(dependency_file_paths, compose_file_dir)
+      dependency_file_paths.map do |dependency_file_path|
+        dependency_file_content = Psych.load(File.read("#{compose_file_dir}/#{dependency_file_path}"))
+
         {
-          path: dependency_file,
-          source: dependency_file,
-          content: Base64.encode64(dependency_file_data),
+          path: dependency_file_path,
+          source: dependency_file_path,
+          content: Base64.encode64(dependency_file_content),
+          use_kind: DEPENDENCY_CONFIG_USE_KIND,
         }
       end
     rescue Errno::ENOENT => e
@@ -34,7 +49,48 @@ class ComposeFileService
       raise Uffizzi::Error.new("The config file #{dependency_path} does not exist")
     end
 
-    def fetch_configs(configs_data)
+    def prepare_dependency_host_volumes_files(dependency_file_paths, compose_file_dir)
+      base_dependency_paths = dependency_file_paths.map do |dependency_file_path|
+        dependency_pathname = Pathname.new(dependency_file_path)
+        next dependency_file_path if dependency_pathname.absolute?
+        next "#{compose_file_dir}/#{dependency_pathname.cleanpath}" if dependency_file_path.start_with?('./')
+        next "#{compose_file_dir}/#{dependency_pathname}" if dependency_file_path.start_with?('../')
+
+        raise Uffizzi::Error.new("Unsupported path #{dependency_pathname}")
+      end
+
+      base_dependency_paths.zip(dependency_file_paths).map do |base_dependency_path, dependency_file_path|
+        absolute_dependency_path = Pathname.new(base_dependency_path).realpath.to_s
+        dependency_file_content = prepare_host_volume_file_content(absolute_dependency_path)
+
+        {
+          path: absolute_dependency_path,
+          source: dependency_file_path,
+          content: dependency_file_content,
+          use_kind: DEPENDENCY_VOLUME_USE_KIND,
+          is_file: Pathname.new(absolute_dependency_path).file?,
+        }
+      end
+    rescue Errno::ENOENT => e
+      dependency_path = e.message.split('- ').last
+      raise Uffizzi::Error.new("No such file or directory: #{dependency_path}")
+    end
+
+    def prepare_host_volume_file_content(path)
+      tmp_tar_name = Base64.encode64(path)[0..20]
+      tmp_tar_path = "/tmp/#{tmp_tar_name}.tar.gz"
+
+      Minitar.pack(path, Zlib::GzipWriter.new(File.open(tmp_tar_path, 'wb')))
+      gzipped_file_size = Pathname.new(tmp_tar_path).size
+
+      if gzipped_file_size > MAX_HOST_VOLUME_GZIP_FILE_SIZE
+        Uffizzi.ui.say("File/Directory too big by path: #{path}. Gzipped tar archive size is #{gzipped_file_size}")
+      end
+
+      Base64.encode64(File.binread(tmp_tar_path))
+    end
+
+    def prepare_config_files_paths(configs_data)
       return [] if configs_data.nil?
 
       Uffizzi.ui.say("Unsupported type of #{:configs} option") unless configs_data.is_a?(Hash)
@@ -68,26 +124,16 @@ class ComposeFileService
       end
     end
 
-    def prepare_services_env_files(services)
+    def prepare_env_files_paths(services)
       return [] if services.nil?
 
-      services.keys.map do |service|
-        service_env_files = prepare_service_env_files(services.fetch(service))
-
-        service_env_files
-      end
-    end
-
-    def prepare_service_env_files(service_data)
-      env_files_data = []
-      service_data.each_pair do |key, value|
-        key_sym = key.to_sym
-        if key_sym == :env_file
-          env_files_data << parse_env_file(value)
-        end
-      end
-
-      env_files_data
+      services
+        .values
+        .select { |s| s.has_key?('env_file') }
+        .map { |s| parse_env_file(s['env_file']) }
+        .flatten
+        .compact
+        .uniq
     end
 
     def parse_compose_content_to_object(compose_content)
@@ -101,5 +147,17 @@ class ComposeFileService
 
       compose_data
     end
+
+    def prepare_host_volumes_paths(services)
+      return [] if services.nil?
+
+      services
+        .values
+        .select { |s| s.has_key?('volumes') }
+        .map { |s| VolumeParserService.parse(s['volumes']) }
+        .flatten
+        .compact
+        .uniq
+    end
   end
 end

data/lib/uffizzi/services/volume_parser_service.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class VolumeParserService
+  class << self
+    def parse(volumes)
+      return [] if volumes.empty?
+
+      Uffizzi.ui.say("Volumes '#{volumes}' should be an array") unless volumes.is_a?(Array)
+
+      volumes.map { |volume| parse_volume(volume) }
+    end
+
+    private
+
+    def parse_volume(volume)
+      case volume
+      when String
+        process_short_syntax(volume)
+      when Hash
+        process_long_syntax(volume)
+      else
+        Uffizzi.ui.say("Unsupported type of '#{volumes}' option")
+      end
+    end
+
+    def process_short_syntax(volume_data)
+      path_part1, path_part2 = volume_data.split(':').map(&:strip)
+
+      path_part1 if host_volume?(path_part1, path_part2)
+    end
+
+    def process_long_syntax(volume_data)
+      source_path = volume_data['source'].to_s.strip
+      target_path = volume_data['target'].to_s.strip
+
+      source_path if host_volume?(source_path, target_path)
+    end
+
+    def host_volume?(source_path, target_path)
+      path?(source_path) && path?(target_path)
+    end
+
+    def path?(path)
+      path.to_s.start_with?('/', './', '../')
+    end
+  end
+end

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deepsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: faker
   requirement: !ruby/object:Gem::Requirement
@@ -347,6 +389,7 @@ files:
 - lib/uffizzi/services/env_variables_service.rb
 - lib/uffizzi/services/preview_service.rb
 - lib/uffizzi/services/project_service.rb
+- lib/uffizzi/services/volume_parser_service.rb
 - lib/uffizzi/shell.rb
 - lib/uffizzi/version.rb
 - man/uffizzi