gitlab-foss/gems/gitlab-backup-cli/lib/gitlab/backup/cli/tasks/task.rb

# frozen_string_literal: true

module Gitlab
  module Backup
    module Cli
      module Tasks
        class Task
          attr_writer :target
          attr_reader :context

          def initialize(context:)
            @context = context
          end

          # Identifier used as parameter in the CLI to skip from executing
          def self.id
            raise NotImplementedError
          end

          # Initiate a backup
          #
          # @param [Pathname] backup_path a path where to store the backups
          def backup!(backup_path)
            backup_output = backup_path.join(destination_path)

            # During test, we ensure storage exists so we can run against `RAILS_ENV=test` environment
            FileUtils.mkdir_p(storage_path) if context&.env&.test? && respond_to?(:storage_path, true)

            target.dump(backup_output)
          end

          def restore!(archive_directory)
            archived_data_location = Pathname(archive_directory).join(destination_path)

            target.restore(archived_data_location)
          end

          # Key string that identifies the task
          def id = self.class.id

          # Name of the task used for logging.
          def human_name
            raise NotImplementedError
          end

          # Where the task should put its backup file/dir
          def destination_path
            raise NotImplementedError
          end

          # Path to remove after a successful backup, uses #destination_path when not specified
          def cleanup_path
            destination_path
          end

          # `true` if the destination might not exist on a successful backup
          def destination_optional
            false
          end

          # `true` if the task can be used
          def enabled
            true
          end

          def enabled?
            enabled
          end

          def config
            return context.config(id) if context

            Output.warning("No context passed to derive configuration from.")
            nil
          end

          def object_storage?
            return false unless config
            return false unless config.respond_to?(:object_store) && config.object_store.enabled

            return false unless Gitlab::Backup::Cli::Targets::ObjectStorage::SUPPORTED_PROVIDERS.include?(
              config.object_store.connection.provider
            )

            true
          end

          def asynchronous?
            target.asynchronous? || false
          end

          def wait_until_done!
            target.wait_until_done!
          end

          def target
            return @target unless @target.nil?

            @target = if object_storage?
                        ::Gitlab::Backup::Cli::Targets::ObjectStorage.find_task(id, options, config)
                      else
                        local
                      end

            @target
          end

          private

          # The target factory method
          def local
            raise NotImplementedError
          end
        end
      end
    end
  end
end