gitlabhq/lib/gitlab/background_migration/remote_development/bm_files.rb

# frozen_string_literal: true

module Gitlab
  module BackgroundMigration
    module RemoteDevelopment
      # This module contains constants for all the files (default devfile, shell scripts, script fragments, commands,
      # etc)
      # that are used in the Remote Development domain. They are pulled out to separate files instead of being hardcoded
      # via inline HEREDOC or other means, so that they can have full support for
      # syntax highlighting, refactoring, linting, etc.
      module BmFiles
        # @param [String] path - file path relative to domain logic root (this directory, `ee/lib/remote_development`)
        # @return [String] content of the file
        def self.read_file(path)
          File.read(File.join(__dir__, path))
        end

        # @return [String] content of the file
        def self.default_devfile_yaml
          # When updating DEFAULT_DEVFILE_YAML contents in `bm_default_devfile.yaml`, update the user facing doc as well
          # https://docs.gitlab.com/ee/user/workspace/#gitlab-default-devfile
          #
          # The container image is pinned to linux/amd64 digest, instead of the tag digest.
          # This is to prevent Rancher Desktop from pulling the linux/arm64 architecture of the image
          # which will disrupt local development since vscode fork and workspace tools image does not support
          # that architecture yet and thus the workspace won't start.
          # This will be fixed in https://gitlab.com/gitlab-org/gitlab/-/issues/550128
          read_file("settings/bm_default_devfile.yaml")
        end

        # @return [String] content of the file
        def self.git_credential_store_script
          read_file("workspace_operations/create/bm_workspace_variables_git_credential_store.sh")
        end

        # @return [String] content of the file
        def self.kubernetes_legacy_poststart_hook_command
          read_file("workspace_operations/create/desired_config/bm_kubernetes_legacy_poststart_hook_command.sh")
        end

        # @return [String] content of the file
        def self.kubernetes_poststart_hook_command
          read_file("workspace_operations/create/desired_config/bm_kubernetes_poststart_hook_command.sh")
        end

        # @return [String] content of the file
        def self.main_component_updater_container_args
          read_file("workspace_operations/create/bm_main_component_updater_container_args.sh")
        end

        # @return [String] content of the file
        def self.internal_poststart_command_start_vscode_script
          read_file("workspace_operations/create/bm_internal_poststart_command_start_vscode.sh")
        end

        # @return [String] content of the file
        def self.internal_poststart_command_sleep_until_workspace_is_running_script
          read_file("workspace_operations/create/bm_internal_poststart_command_sleep_until_workspace_is_running.sh")
        end

        # @return [String] content of the file
        def self.internal_poststart_command_start_sshd_script
          read_file("workspace_operations/create/bm_internal_poststart_command_start_sshd.sh")
        end

        # @return [String] content of the file
        def self.internal_poststart_command_clone_project_script
          read_file("workspace_operations/create/bm_internal_poststart_command_clone_project.sh")
        end

        # @return [String] content of the file
        def self.internal_poststart_command_clone_unshallow_script
          read_file("workspace_operations/create/bm_internal_poststart_command_clone_unshallow.sh")
        end

        ####################################
        # Please keep this list alphabetized
        ####################################

        # NOTE: We intentionally duplicate these explicit declaration of constants in addition to dynamically redefining
        #       them in `reload_constants!` method below. This is because we want them to be resolve-able in IDEs, and
        #       if
        #       we only define them dynamically, they will not be recognized by IDEs.
        DEFAULT_DEVFILE_YAML = default_devfile_yaml
        GIT_CREDENTIAL_STORE_SCRIPT = git_credential_store_script
        INTERNAL_POSTSTART_COMMAND_CLONE_PROJECT_SCRIPT = internal_poststart_command_clone_project_script
        INTERNAL_POSTSTART_COMMAND_CLONE_UNSHALLOW_SCRIPT = internal_poststart_command_clone_unshallow_script
        INTERNAL_POSTSTART_COMMAND_START_VSCODE_SCRIPT = internal_poststart_command_start_vscode_script
        INTERNAL_POSTSTART_COMMAND_SLEEP_UNTIL_WORKSPACE_IS_RUNNING_SCRIPT =
          internal_poststart_command_sleep_until_workspace_is_running_script
        INTERNAL_POSTSTART_COMMAND_START_SSHD_SCRIPT = internal_poststart_command_start_sshd_script
        KUBERNETES_LEGACY_POSTSTART_HOOK_COMMAND = kubernetes_legacy_poststart_hook_command
        KUBERNETES_POSTSTART_HOOK_COMMAND = kubernetes_poststart_hook_command
        MAIN_COMPONENT_UPDATER_CONTAINER_ARGS = main_component_updater_container_args

        # @return [Array]
        def self.all_expected_file_constants
          # NOTE: We explicitly keep a duplicate list of the defined constants, to ensure that we keep both the explicit
          #       declarations above and the dynamically defined ones in reload_constants! in sync.
          [
            :DEFAULT_DEVFILE_YAML,
            :GIT_CREDENTIAL_STORE_SCRIPT,
            :INTERNAL_POSTSTART_COMMAND_CLONE_PROJECT_SCRIPT,
            :INTERNAL_POSTSTART_COMMAND_CLONE_UNSHALLOW_SCRIPT,
            :INTERNAL_POSTSTART_COMMAND_START_VSCODE_SCRIPT,
            :INTERNAL_POSTSTART_COMMAND_SLEEP_UNTIL_WORKSPACE_IS_RUNNING_SCRIPT,
            :INTERNAL_POSTSTART_COMMAND_START_SSHD_SCRIPT,
            :KUBERNETES_LEGACY_POSTSTART_HOOK_COMMAND,
            :KUBERNETES_POSTSTART_HOOK_COMMAND,
            :MAIN_COMPONENT_UPDATER_CONTAINER_ARGS
          ]
        end

        # @return [void]
        def self.reload_constants!
          expected_count = 10 # Update this count if you add/remove constants
          raise "File constants count mismatch!" unless all_expected_file_constants.count == expected_count

          all_expected_file_constants.each do |const_name|
            # If you get an exception on this line, update the `all_file_constants` method above
            remove_const(const_name)
            method_name = const_name.to_s.downcase
            const_set(const_name, public_method(method_name).call)
          end
        end

        private_class_method :all_expected_file_constants, :read_file

        reload_constants!
      end
    end
  end
end