uffizzi_core 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf0385b90270853a0014af3854253436050a54617c7351acb13bd93ab166e92
-  data.tar.gz: 0b0cc859f136ae6c78c358668db24b894e860f4dd56d1b2916aa90af1e3deed0
+  metadata.gz: 40e3a8b7bbd915a1e861fbc7cff0b188741c49be50aa02d8ee05e790e47038a3
+  data.tar.gz: d02d1b3eba6bfbc471266dd28f23200a43cc88c71e7139c1d5bf43c915292f31
 SHA512:
-  metadata.gz: 6a9b81839c201a3958e45ff607141ac0b871694e56d8ffdc9b7c0a94963b9ad620b7d3a7e631b9d346ec8944d8d2e2ce8f3df2ed23faae6c7c637ce4866217b9
-  data.tar.gz: 0eea7cb1e2e2c01d80f6b01733db2424bce357d1f6da54b3f5c118dc78b649db8ac54ff499ca315f3642de55f3d906177b705aa372ae682bc87f6c26a2ac5910
+  metadata.gz: 4bff4a31ff842379bd0907336285b65f31052b58d55ecd104632d483304e07722b75d2591eba942c6583e99ea4f3d23c08765a42b1b102e478f031b5001c4ff4
+  data.tar.gz: 7d0e59f416be2ed26806363b85efa090eb3b02a3ba34546cd5103467d0f80566ddcb7f34270250c8112e65e2c2e35f2ce8dd6fab22f7fb958207e89f72c749f9

data/app/forms/uffizzi_core/api/cli/v1/deployment/create_form.rb

@@ -19,6 +19,7 @@ class UffizziCore::Api::Cli::V1::Deployment::CreateForm < UffizziCore::Deploymen
            { healthcheck: {} },
            { variables: [:name, :value],
              secret_variables: [:name, :value],
+             volumes: [:source, :target, :type, :read_only],
              repo_attributes: [
                :namespace,
                :name,

data/app/forms/uffizzi_core/api/cli/v1/deployment/update_form.rb

@@ -17,6 +17,7 @@ class UffizziCore::Api::Cli::V1::Deployment::UpdateForm < UffizziCore::Deploymen
     :continuously_deploy,
     { variables: [:name, :value],
       secret_variables: [:name, :value],
+      volumes: [:source, :target, :type, :read_only],
       repo_attributes: [
         :namespace,
         :name,

data/app/forms/uffizzi_core/api/cli/v1/template/create_form.rb

@@ -21,6 +21,7 @@ class UffizziCore::Api::Cli::V1::Template::CreateForm < UffizziCore::Template
              :healthcheck,
              { variables: [:name, :value],
                secret_variables: [:name, :value],
+               volumes: [:source, :target, :type, :read_only],
                repo_attributes: [
                  :namespace,
                  :name,

data/app/serializers/uffizzi_core/api/cli/v1/projects/deployment_serializer/container_serializer.rb

@@ -20,7 +20,8 @@ class UffizziCore::Api::Cli::V1::Projects::DeploymentSerializer::ContainerSerial
              :repo_id,
              :continuously_deploy,
              :receive_incoming_requests,
-             :healthcheck
+             :healthcheck,
+             :volumes
 
   def secret_variables
     return unless object.secret_variables.present?

data/app/serializers/uffizzi_core/controller/deploy_containers/container_serializer.rb

@@ -16,7 +16,9 @@ class UffizziCore::Controller::DeployContainers::ContainerSerializer < UffizziCo
              :public,
              :controller_name,
              :receive_incoming_requests,
-             :healthcheck
+             :healthcheck,
+             :volumes,
+             :service_name
 
   has_many :container_config_files
 

data/app/services/uffizzi_core/amazon_service.rb

@@ -16,20 +16,6 @@ class UffizziCore::AmazonService
       parsed_host[3]
     end
 
-    def process_webhook(event, event_data)
-      case event
-      when 'PUSH'
-        source = UffizziCore::Repo::Amazon.name
-        image = event_data['repository-name']
-        tag = event_data['image-tag']
-
-        UffizziCore::ContinuouslyDeployService.run_docker_registry_process(source, image, tag)
-        UffizziCore::ContinuousPreviewService.run_docker_registry_process(source, image, tag)
-      else
-        Rails.logger.warn("Amazon #{event} event doesn't support")
-      end
-    end
-
     private
 
     def client(credential)

data/app/services/uffizzi_core/compose_file/builders/container_builder_service.rb

@@ -9,6 +9,7 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
     @repositories = repositories
   end
 
+  # rubocop:disable Metrics/PerceivedComplexity
   def build_attributes(container_data, ingress_data, continuous_preview_global_data, compose_dependencies)
     image_data = container_data[:image] || {}
     build_data = container_data[:build] || {}
@@ -18,6 +19,7 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
     secrets = container_data[:secrets] || []
     container_name = container_data[:container_name]
     healthcheck_data = container_data[:healthcheck] || {}
+    volumes = container_data[:volumes] || []
 
     env_file_dependencies = UffizziCore::ComposeFile::GithubDependenciesService.env_file_dependencies_for_container(compose_dependencies,
                                                                                                                     container_name)
@@ -44,8 +46,10 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
       service_name: container_name,
       name: container_name,
       healthcheck: healthcheck_data,
+      volumes: volumes,
     }
   end
+  # rubocop:enable Metrics/PerceivedComplexity
 
   private
 

data/app/services/uffizzi_core/compose_file/parsers/services/volumes_service.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class UffizziCore::ComposeFile::Parsers::Services::VolumesService
+  HOST_VOLUME_TYPE = :host
+  NAMED_VOLUME_TYPE = :named
+  ANONYMOUS_VOLUME_TYPE = :anonymous
+  READONLY_OPTION = 'ro'
+  READ_WRITE_OPTION = 'rw'
+
+  class << self
+    def parse(volumes, named_volumes_names, service_name)
+      return [] if volumes.blank?
+
+      volumes.map do |volume|
+        volume_data = case volume
+                      when String
+                        process_short_syntax(volume, named_volumes_names, service_name)
+                      when Hash
+                        process_long_syntax(volume, named_volumes_names, service_name)
+                      else
+                        raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_type', option: :volumes)
+        end
+
+        volume_data
+      end
+    end
+
+    private
+
+    def process_short_syntax(volume_data, named_volumes_names, service_name)
+      volume_parts = volume_data.split(':').map(&:strip)
+      has_read_only = volume_parts.include?(READONLY_OPTION)
+      part1, part2 = volume_parts
+      source_path = part1
+      target_path = [READONLY_OPTION, READ_WRITE_OPTION].include?(part2.to_s.downcase) ? nil : part2
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.volume_prop_is_required', prop_name: 'source') if source_path.blank?
+
+      volume_type = volume_type(source_path, target_path)
+
+      check_named_volume_existence(source_path, target_path, named_volumes_names, service_name) if volume_type == NAMED_VOLUME_TYPE
+
+      {
+        source: source_path,
+        target: target_path,
+        type: volume_type,
+        read_only: has_read_only,
+      }
+    end
+
+    def process_long_syntax(volume_data, named_volumes_names, service_name)
+      source_path = volume_data['source'].to_s.strip
+      target_path = volume_data['target'].to_s.strip
+      has_read_only = volume_data['read_only'].present?
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.volume_prop_is_required', prop_name: 'source') if source_path.blank?
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.volume_prop_is_required', prop_name: 'target') if target_path.blank?
+
+      volume_type = volume_type(source_path, target_path)
+
+      check_named_volume_existence(source_path, target_path, named_volumes_names, service_name) if volume_type == NAMED_VOLUME_TYPE
+
+      {
+        source: source_path,
+        target: target_path,
+        type: volume_type,
+        read_only: has_read_only,
+      }
+    end
+
+    def volume_type(source_path, target_path)
+      if path?(source_path) && path?(target_path)
+        raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.volume_type_not_supported', type: HOST_VOLUME_TYPE)
+      end
+
+      return ANONYMOUS_VOLUME_TYPE if path?(source_path) && target_path.blank?
+      return NAMED_VOLUME_TYPE if source_path.present? && !path?(source_path) && path?(target_path)
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.volume_path_is_invalid', path: [source_path, target_path].join(':'))
+    end
+
+    def path?(path)
+      /^(\/|\.\/|~\/)/.match?(path)
+    end
+
+    def check_named_volume_existence(source_path, target_path, named_volumes_names, service_name)
+      return if named_volumes_names.include?(source_path)
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.named_volume_not_exists', source_path: source_path,
+                                                                                            target_path: target_path,
+                                                                                            service_name: service_name)
+    end
+  end
+end

data/app/services/uffizzi_core/compose_file/parsers/services_parser_service.rb

@@ -4,11 +4,12 @@ class UffizziCore::ComposeFile::Parsers::ServicesParserService
   class << self
     include UffizziCore::DependencyInjectionConcern
 
-    def parse(services, global_configs_data, global_secrets_data, compose_payload)
+    def parse(services, global_configs_data, global_secrets_data, compose_payload, global_named_volume_names)
       raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.no_services') if services.nil? || services.keys.empty?
 
       services.keys.map do |service|
-        service_data = prepare_service_data(service, services.fetch(service), global_configs_data, global_secrets_data, compose_payload)
+        service_data = prepare_service_data(service, services.fetch(service), global_configs_data,
+                                            global_secrets_data, compose_payload, global_named_volume_names)
 
         if service_data[:image].blank? && service_data[:build].blank?
           raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.image_build_no_specified', value: service)
@@ -20,7 +21,8 @@ class UffizziCore::ComposeFile::Parsers::ServicesParserService
 
     private
 
-    def prepare_service_data(service_name, service_data, global_configs_data, global_secrets_data, compose_payload)
+    def prepare_service_data(service_name, service_data, global_configs_data,
+                             global_secrets_data, compose_payload, global_named_volume_names)
       options_data = {}
       service_data.each_pair do |key, value|
         service_key = key.to_sym
@@ -48,6 +50,10 @@ class UffizziCore::ComposeFile::Parsers::ServicesParserService
                                       UffizziCore::ComposeFile::Parsers::Services::HealthcheckParserService.parse(value)
                                     when :'x-uffizzi-continuous-preview', :'x-uffizzi-continuous-previews'
                                       UffizziCore::ComposeFile::Parsers::ContinuousPreviewParserService.parse(value)
+                                    when :volumes
+                                      UffizziCore::ComposeFile::Parsers::Services::VolumesService.parse(value,
+                                                                                                        global_named_volume_names,
+                                                                                                        service_name)
         end
       end
 

data/app/services/uffizzi_core/compose_file/parsers/volumes_parser_service.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class UffizziCore::ComposeFile::Parsers::VolumesParserService
+  VALID_VOLUME_NAME_REGEX = /^[a-zA-Z0-9._-]+$/.freeze
+
+  class << self
+    def parse(volumes_data)
+      return [] if volumes_data.nil?
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_type', option: :volumes) unless volumes_data.is_a?(Hash)
+
+      volume_names = volumes_data.keys
+      volume_names.each do |volume_name|
+        unless volume_name.match?(VALID_VOLUME_NAME_REGEX)
+          raise UffizziCore::ComposeFile::ParseError,
+                I18n.t('compose.volume_invalid_name', name: volume_name)
+        end
+      end
+
+      volume_names
+    end
+  end
+end

data/app/services/uffizzi_core/compose_file_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::ComposeFileService
+class UffizziCore::ComposeFileService
   class << self
     def create(params, kind)
       compose_file_form = create_compose_form(params, kind)
@@ -19,13 +19,14 @@ module UffizziCore::ComposeFileService
       check_config_options_format(compose_data)
       configs_data = UffizziCore::ComposeFile::Parsers::ConfigsParserService.parse(compose_data['configs'])
       secrets_data = UffizziCore::ComposeFile::Parsers::SecretsParserService.parse(compose_data['secrets'])
+      named_volume_names = UffizziCore::ComposeFile::Parsers::VolumesParserService.parse(compose_data['volumes'])
       containers_data = UffizziCore::ComposeFile::Parsers::ServicesParserService.parse(
         compose_data['services'],
         configs_data,
         secrets_data,
         compose_payload,
+        named_volume_names,
       )
-
       continuous_preview_option = UffizziCore::ComposeFile::ConfigOptionService.continuous_preview_option(compose_data)
       continuous_preview_data = UffizziCore::ComposeFile::Parsers::ContinuousPreviewParserService.parse(continuous_preview_option)
 

data/app/services/uffizzi_core/controller_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::ControllerService
+class UffizziCore::ControllerService
   class << self
     def apply_config_file(deployment, config_file)
       body = {

data/app/services/uffizzi_core/credential_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::CredentialService
+class UffizziCore::CredentialService
   class << self
     def correct_credentials?(credential)
       status = case credential.type

data/app/services/uffizzi_core/deployment_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::DeploymentService
+class UffizziCore::DeploymentService
   MIN_TARGET_PORT_RANGE = 37_000
   MAX_TARGET_PORT_RANGE = 39_999
 

data/app/services/uffizzi_core/docker_hub_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::DockerHubService
+class UffizziCore::DockerHubService
   HOOK_NAME = 'Uffizzi OpenSource Deploy Webhook'
   HOOK_URL = "#{Settings.app.host}api/cli/v1/webhooks/docker_hub"
   REGISTRY = 'registry-1.docker.io'

data/app/services/uffizzi_core/google_service.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class UffizziCore::GoogleService
+  class << self
+    def digest(credential, image, tag)
+      response = registry_client(credential).manifests(image: image, tag: tag)
+
+      response.headers['docker-content-digest']
+    end
+
+    private
+
+    def registry_client(credential)
+      UffizziCore::GoogleRegistryClient.new(
+        registry_url: credential.registry_url,
+        username: credential.username,
+        password: credential.password,
+      )
+    end
+  end
+end

data/app/services/uffizzi_core/project_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::ProjectService
+class UffizziCore::ProjectService
   class << self
     def update_compose_secrets(project)
       compose_file = project.compose_file

data/app/services/uffizzi_core/repo_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module UffizziCore::RepoService
+class UffizziCore::RepoService
   class << self
     def needs_target_port?(repo)
       return false if repo.nil?

data/config/locales/en.yml

@@ -61,6 +61,11 @@ en:
     string_or_array_error: "'%{option}' contains an invalid type, it should be a string, or an array"
     not_implemented: "'%{option}' option is not implemented"
     infinite_recursion: "Found infinite recursion for key '%{key}'"
+    volume_path_is_invalid: The path '%{path}' is invalid
+    volume_prop_is_required: The '%{prop_name}' is a required property
+    volume_invalid_name: "Volumes value '%{name}' does not match any of the regexes: '^[a-zA-Z0-9._-]+$'"
+    volume_type_not_supported: Volumes with type '%{type}' does not supported
+    named_volume_not_exists: Named volume '%{source_path}:%{target_path}' is used in service '%{service_name}' but no declaration was found in the volumes section.
   secrets:
     duplicates_exists: Secret with key %{secrets} already exist.
     invalid_key_length: A secret key must be no longer than 256 characters.

data/db/migrate/20220422151523_add_volumes_to_uffizzi_core_containers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddVolumesToUffizziCoreContainers < ActiveRecord::Migration[6.1]
+  def change
+    add_column(:uffizzi_core_containers, :volumes, :jsonb)
+  end
+end

data/lib/uffizzi_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UffizziCore
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi_core
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -913,8 +913,10 @@ files:
 - app/services/uffizzi_core/compose_file/parsers/services/healthcheck_parser_service.rb
 - app/services/uffizzi_core/compose_file/parsers/services/image_parser_service.rb
 - app/services/uffizzi_core/compose_file/parsers/services/secrets_parser_service.rb
+- app/services/uffizzi_core/compose_file/parsers/services/volumes_service.rb
 - app/services/uffizzi_core/compose_file/parsers/services_parser_service.rb
 - app/services/uffizzi_core/compose_file/parsers/variables_parser_service.rb
+- app/services/uffizzi_core/compose_file/parsers/volumes_parser_service.rb
 - app/services/uffizzi_core/compose_file/template_service.rb
 - app/services/uffizzi_core/compose_file_service.rb
 - app/services/uffizzi_core/container_service.rb
@@ -925,6 +927,7 @@ files:
 - app/services/uffizzi_core/docker_hub_service.rb
 - app/services/uffizzi_core/github_container_registry/credential_service.rb
 - app/services/uffizzi_core/google/credential_service.rb
+- app/services/uffizzi_core/google_service.rb
 - app/services/uffizzi_core/logs_service.rb
 - app/services/uffizzi_core/manage_activity_items_service.rb
 - app/services/uffizzi_core/project_service.rb
@@ -952,6 +955,7 @@ files:
 - db/migrate/20220329124542_add_resource_to_secrets.rb
 - db/migrate/20220329143241_remove_project_ref_from_secrets.rb
 - db/migrate/20220419074956_add_health_check_to_containers.rb
+- db/migrate/20220422151523_add_volumes_to_uffizzi_core_containers.rb
 - db/migrate/20220525113412_rename_name_to_uffizzi_containers.rb
 - db/seeds.rb
 - lib/tasks/uffizzi_core_tasks.rake