uffizzi_core 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48e413ec49645c1e18d15251bcfa9ceaf94309be078fd46befbfd97894d9318e
-  data.tar.gz: 213cd12f3c9216b851ccd16c44562da68c954a03f126fd35ec683119ee7b8755
+  metadata.gz: 43f66c059196fdf90a87f740f396bf781294f4dab94c221f38abc58caef7f141
+  data.tar.gz: 3f8aec775f29147cdc79b115401a28414ac19ee9146b9226ea62f5deb0de9083
 SHA512:
-  metadata.gz: 339656968a5609d9674536a6bd36518f2efb33afe30bf77ef2c56d158fe3b1b7a9f27da8dd76dcc8c1f35ad5624121a2914482d296b0b2e5afe9025735dda974
-  data.tar.gz: b5369f15696f2e011b1be386c1ee1b4660a0e5733e09030d0af8095612337cf544e2be0adfce7b3410f0338bd64e7e0d479a0f0f779360d9c99eb6990261670f
+  metadata.gz: 4d90a4d0a13b2d7e899573c8484d6355d751a81bd9648443211b4fa4155f439ae40993a4f3dd18c2ec5079bb183093f0f78b7800d24f96d693a98b3ef9c81a48
+  data.tar.gz: a7dcc2e613d8d5293c070d66f4c1366534c0077c8d5d588906be93b389a51bb88c2951c9db2b68c5236e90933da51af775ae00516afbc34cd6f8c7148ce5bb51

data/README.md

@@ -44,3 +44,9 @@ Or install it yourself as:
 ```bash
 $ gem install uffizzi_core
 ```
+
+## Migrations
+After adding a new migration, ru the following command:
+```
+rake uffizzi_core:install
+```

data/app/controllers/uffizzi_core/api/cli/v1/account/credentials_controller.rb

@@ -15,7 +15,6 @@ class UffizziCore::Api::Cli::V1::Account::CredentialsController < UffizziCore::A
     render json: { credentials: credentials }, status: :ok
   end
 
-  # rubocop:disable Layout/LineLength
   # Create account credential
   #
   # @path [POST] /api/cli/v1/account/credentials
@@ -25,8 +24,9 @@ class UffizziCore::Api::Cli::V1::Account::CredentialsController < UffizziCore::A
   # @response [object<errors>] 422 Unprocessable entity
   #
   # @example
-  #    type can be one of UffizziCore::Credential::Amazon, UffizziCore::Credential::Azure, UffizziCore::Credential::DockerHub, UffizziCore::Credential::Google, UffizziCore::Credential::GithubContainerRegistry
-  # rubocop:enable Layout/LineLength
+  #    type can be one of UffizziCore::Credential::Amazon, UffizziCore::Credential::Azure,
+  #    UffizziCore::Credential::DockerHub, UffizziCore::Credential::Google, UffizziCore::Credential::GithubContainerRegistry
+
   def create
     credential_form = UffizziCore::Api::Cli::V1::Account::Credential::CreateForm.new
     credential_form.assign_attributes(credential_params)

data/app/controllers/uffizzi_core/api/cli/v1/projects_controller.rb

@@ -9,11 +9,77 @@ class UffizziCore::Api::Cli::V1::ProjectsController < UffizziCore::Api::Cli::V1:
   #
   # @path [GET] /api/cli/v1/projects
   #
-  # @response [object<projects: Array<object<slug: string>> >] 200 OK
+  # @response [object<projects: Array<object<slug: string, name: string>> >] 200 OK
   # @response 401 Not authorized
   def index
     projects = current_user.projects.active.order(updated_at: :desc)
 
-    respond_with projects
+    respond_with projects, each_serializer: UffizziCore::Api::Cli::V1::ShortProjectSerializer
+  end
+
+  # Get a project by slug
+  #
+  # @path [GET] /api/cli/v1/projects/{slug}
+  #
+  # @response <object< project: Project>> 200 OK
+  # @response 404 Not Found
+  # @response 401 Not authorized
+  def show
+    project = current_user.projects.find_by!(slug: params[:slug])
+
+    respond_with project
+  end
+
+  # Create a project
+  #
+  # @path [POST] /api/cli/v1/projects
+  # @parameter params(required,body) [object<name: string, slug: string, description: string>]
+  #
+  # @response <object< project: Project>> 200 OK
+  # @response 404 Not Found
+  # @response 401 Not authorized
+  # @response [object<errors: object<password: string >>] 422 Unprocessable entity
+
+  def create
+    project_form = UffizziCore::Api::Cli::V1::Project::CreateForm.new(project_params)
+    project_form.account = current_user.organizational_account
+
+    if project_form.save
+      current_membership = current_user.memberships.find_by(account: current_user.organizational_account)
+      user_projects = []
+
+      if current_membership.developer?
+        user_projects << { project: project_form, user: current_user, role: UffizziCore::UserProject.role.developer }
+      end
+
+      current_user.organizational_account.memberships.where(role: UffizziCore::Membership.role.admin).map do |membership|
+        user_projects << { project: project_form, user: membership.user, role: UffizziCore::UserProject.role.admin }
+      end
+
+      UffizziCore::UserProject.create!(user_projects)
+    end
+
+    respond_with project_form
+  end
+
+  # Delete a project
+  #
+  # @path [DELETE] /api/cli/v1/projects/{slug}
+  #
+  # @response 204 No content
+  # @response 404 Not Found
+  # @response 401 Not authorized
+
+  def destroy
+    project = current_user.organizational_account.active_projects.find_by!(slug: params[:slug])
+    project.disable!
+
+    head :no_content
+  end
+
+  private
+
+  def project_params
+    params.require(:project)
   end
 end

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

@@ -16,6 +16,7 @@ class UffizziCore::Api::Cli::V1::Deployment::CreateForm < UffizziCore::Deploymen
            :command,
            :receive_incoming_requests,
            :continuously_deploy,
+           { healthcheck: {} },
            { variables: [:name, :value],
              secret_variables: [:name, :value],
              repo_attributes: [

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UffizziCore::Api::Cli::V1::Project::CreateForm < UffizziCore::Project
+  include UffizziCore::ApplicationForm
+
+  permit :name, :slug, :description
+end

data/app/lib/uffizzi_core/concerns/models/activity_item.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module UffizziCore::Concerns::Models::ActivityItem
+  extend ActiveSupport::Concern
+
+  included do
+    include UffizziCore::ActivityItemRepo
+
+    self.table_name = UffizziCore.table_names[:activity_items]
+
+    belongs_to :deployment
+    belongs_to :container
+    belongs_to :build, optional: true
+
+    has_many :events, dependent: :destroy
+
+    scope :docker, -> {
+      where(type: UffizziCore::ActivityItem::Docker.name)
+    }
+
+    scope :github, -> {
+      where(type: UffizziCore::ActivityItem::Github.name)
+    }
+
+    def docker?
+      type == UffizziCore::ActivityItem::Docker.name
+    end
+
+    def image
+      [namespace, name].compact.join('/')
+    end
+
+    def full_image
+      return "#{image}:#{tag}" if docker?
+
+      ''
+    end
+  end
+end

data/app/lib/uffizzi_core/concerns/models/credential.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module UffizziCore::Concerns::Models::Credential
+  extend ActiveSupport::Concern
+
+  included do
+    include AASM
+    include UffizziCore::CredentialRepo
+
+    self.table_name = UffizziCore.table_names[:credentials]
+
+    belongs_to :account
+
+    before_destroy :remove_token
+
+    validates :registry_url, presence: true
+
+    aasm :state, column: :state do
+      state :not_connected, initial: true
+      state :active
+      state :unauthorized
+
+      event :activate do
+        transitions from: [:not_connected, :unauthorized], to: :active
+      end
+
+      event :unauthorize do
+        transitions from: [:not_connected, :active], to: :unauthorized
+      end
+    end
+
+    def github_container_registry?
+      type == UffizziCore::Credential::GithubContainerRegistry.name
+    end
+
+    def docker_hub?
+      type == UffizziCore::Credential::DockerHub.name
+    end
+
+    def azure?
+      type == UffizziCore::Credential::Azure.name
+    end
+
+    def google?
+      type == UffizziCore::Credential::Google.name
+    end
+
+    def amazon?
+      type == UffizziCore::Credential::Amazon.name
+    end
+
+    private
+
+    def remove_token
+      account.projects.find_each do |project|
+        project.deployments.find_each do |deployment|
+          containers = deployment.containers
+          attributes = { continuously_deploy: UffizziCore::Container::STATE_DISABLED }
+
+          containers.with_docker_hub_repo.update_all(attributes) if docker_hub?
+        end
+      end
+    end
+  end
+end

data/app/lib/uffizzi_core/concerns/models/repo.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module UffizziCore::Concerns::Models::Repo
+  extend ActiveSupport::Concern
+
+  included do
+    extend Enumerize
+    include UffizziCore::RepoRepo
+
+    self.table_name = UffizziCore.table_names[:repos]
+
+    enumerize :kind, in: [:buildpacks18, :dockerfile, :dotnet, :gatsby, :barestatic], predicates: true
+
+    belongs_to :project
+    has_one :container, inverse_of: :repo, dependent: :destroy
+    has_many :builds, dependent: :destroy
+
+    validates :dockerfile_path, presence: true, if: :dockerfile?
+    validates :delete_preview_after, numericality: { greater_than: 0, only_integer: true }, allow_nil: true
+
+    def docker_hub?
+      type == UffizziCore::Repo::DockerHub.name
+    end
+
+    def azure?
+      type == UffizziCore::Repo::Azure.name
+    end
+
+    def google?
+      type == UffizziCore::Repo::Google.name
+    end
+  end
+end

data/app/lib/uffizzi_core/rbac/user_access_service.rb

@@ -6,10 +6,34 @@ module UffizziCore::Rbac::UserAccessService
       true
     end
 
+    def developer_access_to_account?(_user, _account)
+      true
+    end
+
+    def viewer_access_to_account?(_user, _account)
+      true
+    end
+
+    def admin_or_developer_access_to_account?(_user, _account)
+      true
+    end
+
     def any_access_to_account?(_user, _account)
       true
     end
 
+    def admin_access_to_project?(_user, _project)
+      true
+    end
+
+    def developer_access_to_project?(_user, _project)
+      true
+    end
+
+    def viewer_access_to_project?(_user, _project)
+      true
+    end
+
     def admin_or_developer_access_to_project?(_user, _project)
       true
     end

data/app/models/uffizzi_core/project.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-# @model
+# @model Project
 # @property slug [string]
+# @property name [string]
+# @property description [string]
+# @property created_at [date-time]
+# @property secrets [string]
+# @property default_compose [object<source: string>]
+# @property deployments [object<id: integer, domain: string>]
 
 class UffizziCore::Project < UffizziCore::ApplicationRecord
   include AASM
@@ -23,7 +29,8 @@ class UffizziCore::Project < UffizziCore::ApplicationRecord
   has_many :compose_files, dependent: :destroy
   has_many :secrets, dependent: :destroy, as: :resource
 
-  validates :name, presence: true, uniqueness: { scope: :account }
+  validates :name, presence: true, uniqueness: { scope: :account, message: 'Name already exists' }
+  validates :slug, presence: true, uniqueness: { message: 'Project slug already taken' }
 
   aasm(:state) do
     state :active, initial: true

data/app/policies/uffizzi_core/api/cli/v1/projects_policy.rb

@@ -4,4 +4,16 @@ class UffizziCore::Api::Cli::V1::ProjectsPolicy < UffizziCore::ApplicationPolicy
   def index?
     context.user_access_module.any_access_to_account?(context.user, context.account)
   end
+
+  def show?
+    context.user_access_module.any_access_to_account?(context.user, context.account)
+  end
+
+  def create?
+    context.user_access_module.admin_or_developer_access_to_account?(context.user, context.account)
+  end
+
+  def destroy?
+    context.user_access_module.admin_or_developer_access_to_account?(context.user, context.account)
+  end
 end

data/app/serializers/uffizzi_core/api/cli/v1/project_serializer/compose_file_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UffizziCore::Api::Cli::V1::ProjectSerializer::ComposeFileSerializer < UffizziCore::BaseSerializer
+  type :compose_file
+
+  attributes :source
+end

data/app/serializers/uffizzi_core/api/cli/v1/project_serializer/deployment_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class UffizziCore::Api::Cli::V1::ProjectSerializer::DeploymentSerializer < UffizziCore::BaseSerializer
+  type :deployment
+
+  attributes :id,
+             :preview_url,
+             :state
+
+  def preview_url
+    UffizziCore::DeploymentService.build_preview_url(object)
+  end
+end

data/app/serializers/uffizzi_core/api/cli/v1/project_serializer.rb

@@ -2,6 +2,29 @@
 
 class UffizziCore::Api::Cli::V1::ProjectSerializer < UffizziCore::BaseSerializer
   type :project
+  has_many :deployments
+  has_many :secrets
+  has_one :default_compose
 
-  attributes :slug
+  attributes :name,
+             :slug,
+             :description,
+             :created_at
+
+  def default_compose
+    object.compose_files.main.first
+  end
+
+  def deployments
+    object.deployments.active.map do |deployment|
+      deployment.state = UffizziCore::DeploymentService.failed?(deployment) ? 'failed' : 'active'
+      deployment
+    end
+  end
+
+  def secrets
+    return [] unless object.secrets
+
+    object.secrets.map(&:name)
+  end
 end

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

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

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class UffizziCore::Api::Cli::V1::Projects::Deployments::ContainerSerializer < UffizziCore::BaseSerializer
-  attributes :id, :name, :memory_limit, :memory_request, :continuously_deploy, :variables, :secret_variables
+  attributes :id, :name, :memory_limit, :memory_request, :continuously_deploy, :variables, :secret_variables, :healthcheck
 
   has_many :container_config_files
 

data/app/serializers/uffizzi_core/api/cli/v1/short_project_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UffizziCore::Api::Cli::V1::ShortProjectSerializer < UffizziCore::BaseSerializer
+  type :project
+
+  attributes :name, :slug
+end

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

@@ -15,7 +15,8 @@ class UffizziCore::Controller::DeployContainers::ContainerSerializer < UffizziCo
              :target_port,
              :public,
              :controller_name,
-             :receive_incoming_requests
+             :receive_incoming_requests,
+             :healthcheck
 
   has_many :container_config_files
 
@@ -52,4 +53,18 @@ class UffizziCore::Controller::DeployContainers::ContainerSerializer < UffizziCo
   def command
     object.command.blank? ? nil : JSON.parse(object.command)
   end
+
+  def healthcheck
+    return {} if object.healthcheck.nil?
+
+    command = object.healthcheck['test']
+    new_command = if command.is_a?(Array)
+      items_to_remove = ['CMD', 'CMD-SHELL']
+      command.select { |item| items_to_remove.exclude?(item) }
+    elsif object.healthcheck['test'].is_a?(String)
+      command.split
+    end
+
+    object.healthcheck.merge(test: new_command)
+  end
 end

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

@@ -17,18 +17,14 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
     configs_data = container_data[:configs] || []
     secrets = container_data[:secrets] || []
     container_name = container_data[:container_name]
-    continuous_preview_container_data = container_data[:'x-uffizzi-continuous-preview'] || container_data[:'x-uffizzi-continuous-previews']
+    healthcheck_data = container_data[:healthcheck] || {}
 
     env_file_dependencies = UffizziCore::ComposeFile::GithubDependenciesService.env_file_dependencies_for_container(compose_dependencies,
                                                                                                                     container_name)
     configs_dependencies = UffizziCore::ComposeFile::GithubDependenciesService.configs_dependencies_for_container(compose_dependencies,
                                                                                                                   container_name)
-
     is_ingress = ingress_container?(container_name, ingress_data)
-    repo_attributes = build_repo_attributes(container_data, image_data, build_data, credentials)
-
-    repo_attributes = set_continuous_preview_attributes_to_repo(repo_attributes, continuous_preview_global_data.to_h,
-                                                                continuous_preview_container_data.to_h)
+    repo_attributes = repo_attributes(container_data, continuous_preview_global_data)
 
     {
       tag: tag(image_data, repo_attributes),
@@ -51,6 +47,13 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
 
   private
 
+  def repo_attributes(container_data, continuous_preview_global_data)
+    repo_attributes = build_repo_attributes(container_data)
+    continuous_preview_container_data = container_data[:'x-uffizzi-continuous-preview'] || container_data[:'x-uffizzi-continuous-previews']
+
+    set_continuous_preview_attributes_to_repo(repo_attributes, continuous_preview_global_data.to_h, continuous_preview_container_data.to_h)
+  end
+
   def set_continuous_preview_attributes_to_repo(repo_attributes, global_data, container_data)
     condition_attributes = [
       :deploy_preview_when_pull_request_is_opened,
@@ -148,8 +151,9 @@ class UffizziCore::ComposeFile::Builders::ContainerBuilderService
     memory_value
   end
 
-  def build_repo_attributes(container_data, image_data, _build_data, credentials)
+  def build_repo_attributes(container_data)
     repo_type = repo_type(container_data)
+    image_data = container_data[:image]
 
     case repo_type
     when UffizziCore::Repo::DockerHub.name

data/app/services/uffizzi_core/compose_file/config_option_service.rb

@@ -12,6 +12,10 @@ class UffizziCore::ComposeFile::ConfigOptionService
 
     def config_options(compose_data)
       compose_data.each_with_object([]) do |(key, value), keys|
+        if compose_data.equal?(value)
+          raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.infinite_recursion', key: key)
+        end
+
         keys << key
         keys.concat(config_options(value)) if value.is_a?(Hash)
       end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class UffizziCore::ComposeFile::Parsers::Services::HealthcheckParserService
+  REQUIRED_START_COMMANDS = ['NONE', 'CMD', 'CMD-SHELL'].freeze
+
+  class << self
+    def parse(healthcheck_data)
+      return {} if healthcheck_data.blank?
+
+      command = parse_command(healthcheck_data)
+
+      {
+        test: command,
+        interval: parse_time(healthcheck_data['interval']),
+        timeout: parse_time(healthcheck_data['timeout']),
+        retries: parse_retries(healthcheck_data['retries']),
+        start_period: parse_time(healthcheck_data['start_period']),
+        disable: parse_disable_option(healthcheck_data['disable'], command),
+      }
+    end
+
+    private
+
+    def parse_command(healthcheck_data)
+      command = healthcheck_data['test']
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.string_or_array_error', option: :test) if command.nil?
+
+      case command
+      when Array
+        start_command = command.first
+        raise UffizziCore::ComposeFile::ParseError unless REQUIRED_START_COMMANDS.include?(start_command)
+
+        command
+      when String
+        command
+      else
+        raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_type', option: :test)
+      end
+    end
+
+    def parse_retries(value)
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_integer', option: :retries) unless value.is_a?(Integer)
+    end
+
+    def parse_time(value)
+      tokens = {
+        's' => 1,
+        'm' => 60,
+        'h' => (60 * 60),
+        'd' => (60 * 60 * 24),
+      }
+
+      time_parts = value.scan(/(\d+)(\w)/).compact
+
+      time_parts.reduce(0) do |acc, part|
+        amount, measure = part
+        acc += amount.to_i * tokens[measure]
+
+        acc
+      rescue StandardError
+        raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_time_interval')
+      end
+    end
+
+    def parse_disable_option(value, command)
+      return true if command.is_a?(Array) && command.first == 'NONE'
+      return false if value.nil?
+      return value if value.in?([true, false])
+
+      raise UffizziCore::ComposeFile::ParseError, I18n.t('compose.invalid_bool_value', field: 'disable', value: value)
+    end
+  end
+end

data/app/services/uffizzi_core/compose_file/services_options_service.rb

@@ -42,6 +42,8 @@ class UffizziCore::ComposeFile::ServicesOptionsService
                                       UffizziCore::ComposeFile::ServicesOptions::EntrypointService.parse(value)
                                     when :command
                                       UffizziCore::ComposeFile::ServicesOptions::CommandService.parse(value)
+                                    when :healthcheck
+                                      UffizziCore::ComposeFile::Parsers::Services::HealthcheckParserService.parse(value)
                                     when :'x-uffizzi-continuous-preview', :'x-uffizzi-continuous-previews'
                                       UffizziCore::ComposeFile::ContinuousPreviewOptionsService.parse(value)
         end

data/app/services/uffizzi_core/compose_file/template_service.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 class UffizziCore::ComposeFile::TemplateService
-  def initialize(github_form, project, user)
+  def initialize(cli_form, project, user)
     @project = project
     @user = user
-    @compose_dependencies = github_form.compose_dependencies
-    @compose_data = github_form.compose_data
-    @compose_repositories = github_form.compose_repositories
+    @compose_dependencies = cli_form.compose_dependencies
+    @compose_data = cli_form.compose_data
+    @compose_repositories = cli_form.compose_repositories
   end
 
   def create_template(compose_file_form)

data/app/services/uffizzi_core/compose_file_service.rb

@@ -158,7 +158,7 @@ module UffizziCore::ComposeFileService
 
     def load_compose_data(compose_content)
       begin
-        compose_data = YAML.safe_load(compose_content)
+        compose_data = YAML.safe_load(compose_content, aliases: true)
       rescue Psych::SyntaxError
         raise UffizziCore::ComposeFile::ParseError, 'Invalid compose file'
       end