Merge branch 'move_ci_config_path_project_variable' into 'master'

Updates to CI_CONFIG_PATH and CI_PROJECT_CONFIG_PATH variables

See merge request gitlab-org/gitlab!54498

app/models/ci/pipeline.rb

@@ -693,14 +693,6 @@ module Ci
         .exists?
     end
 
-    # TODO: this logic is duplicate with Pipeline::Chain::Config::Content
-    # we should persist this is `ci_pipelines.config_path`
-    def config_path
-      return unless repository_source? || unknown_source?
-
-      project.ci_config_path_or_default
-    end
-
     def has_yaml_errors?
       yaml_errors.present?
     end
@@ -786,8 +778,6 @@ module Ci
         variables.append(key: 'CI_PIPELINE_IID', value: iid.to_s)
         variables.append(key: 'CI_PIPELINE_SOURCE', value: source.to_s)
 
-        variables.append(key: 'CI_CONFIG_PATH', value: config_path)
-
         variables.concat(predefined_commit_variables)
 
         if merge_request?

app/models/project.rb

@@ -1987,6 +1987,7 @@ class Project < ApplicationRecord
       .append(key: 'CI_PROJECT_REPOSITORY_LANGUAGES', value: repository_languages.map(&:name).join(',').downcase)
       .append(key: 'CI_DEFAULT_BRANCH', value: default_branch)
       .append(key: 'CI_PROJECT_CONFIG_PATH', value: ci_config_path_or_default)
+      .append(key: 'CI_CONFIG_PATH', value: ci_config_path_or_default)
   end
 
   def predefined_ci_server_variables

changelogs/unreleased/move_ci_config_path_project_variable.yml

+---
+title: Move CI_CONFIG_PATH as project variable and deprecate CI_PROJECT_CONFIG_PATH
+merge_request: 54498
+author:
+type: changed

doc/ci/variables/predefined_variables.md

@@ -72,7 +72,7 @@ There are also [Kubernetes-specific deployment variables](../../user/project/clu
 | `CI_PIPELINE_SOURCE`                     | 10.0   | all    | How the pipeline was triggered. Can be `push`, `web`, `schedule`, `api`, `external`, `chat`, `webide`, `merge_request_event`, `external_pull_request_event`, `parent_pipeline`, [`trigger`, or `pipeline`](../triggers/README.md#authentication-tokens). |
 | `CI_PIPELINE_TRIGGERED`                  | all    | all    | `true` if the job was [triggered](../triggers/README.md). |
 | `CI_PIPELINE_URL`                        | 11.1   | 0.5    | The URL for the pipeline details. |
-| `CI_PROJECT_CONFIG_PATH`                 | 13.8   | all    | The CI/CD configuration path for the project. |
+| `CI_PROJECT_CONFIG_PATH`                 | 13.8   | all    | (Deprecated) The CI configuration path for the project. [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/321334) in GitLab 13.10. [Removal planned](https://gitlab.com/gitlab-org/gitlab/-/issues/322807) for GitLab 14.0. |
 | `CI_PROJECT_DIR`                         | all    | all    | The full path the repository is cloned to, and where the job runs from. If the GitLab Runner `builds_dir` parameter is set, this variable is set relative to the value of `builds_dir`. For more information, see the [Advanced GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section). |
 | `CI_PROJECT_ID`                          | all    | all    | The ID of the current project. This ID is unique across all projects on the GitLab instance. |
 | `CI_PROJECT_NAME`                        | 8.10   | 0.5    | The name of the directory for the project. For example if the project URL is `gitlab.example.com/group-name/project-1`, `CI_PROJECT_NAME` is `project-1`. |

ee/app/presenters/projects/security/configuration_presenter.rb

@@ -61,7 +61,7 @@ module Projects
           latest_pipeline_path: latest_pipeline_path,
           auto_fix_enabled: autofix_enabled,
           can_toggle_auto_fix_settings: auto_fix_permission,
-          gitlab_ci_present: gitlab_ci_present?,
+          gitlab_ci_present: project.uses_default_ci_config?,
           gitlab_ci_history_path: gitlab_ci_history_path,
           auto_fix_user_path: '/' # TODO: real link will be updated with https://gitlab.com/gitlab-org/gitlab/-/issues/215669
         }
@@ -90,10 +90,6 @@ module Projects
           !archived?
       end
 
-      def gitlab_ci_present?
-        latest_pipeline.try(:config_path) == Gitlab::FileDetector::PATTERNS[:gitlab_ci]
-      end
-
       def gitlab_ci_history_path
         return '' if project.empty_repo?
 

ee/spec/presenters/projects/security/configuration_presenter_spec.rb

@@ -218,8 +218,9 @@ RSpec.describe Projects::Security::ConfigurationPresenter do
           expect(subject[:gitlab_ci_present]).to eq(true)
         end
 
-        it 'expects the gitlab_ci_presence to be false if the file is absent' do
-          allow_any_instance_of(described_class).to receive(:latest_pipeline).and_return(nil)
+        it 'expects the gitlab_ci_presence to be false if the file is customized' do
+          allow(project).to receive(:ci_config_path).and_return('.other-gitlab-ci.yml')
+
           expect(subject[:gitlab_ci_present]).to eq(false)
         end
       end

spec/models/ci/build_spec.rb

@@ -2405,6 +2405,7 @@ RSpec.describe Ci::Build do
           { key: 'CI_PROJECT_REPOSITORY_LANGUAGES', value: project.repository_languages.map(&:name).join(',').downcase, public: true, masked: false },
           { key: 'CI_DEFAULT_BRANCH', value: project.default_branch, public: true, masked: false },
           { key: 'CI_PROJECT_CONFIG_PATH', value: project.ci_config_path_or_default, public: true, masked: false },
+          { key: 'CI_CONFIG_PATH', value: project.ci_config_path_or_default, public: true, masked: false },
           { key: 'CI_PAGES_DOMAIN', value: Gitlab.config.pages.host, public: true, masked: false },
           { key: 'CI_PAGES_URL', value: project.pages_url, public: true, masked: false },
           { key: 'CI_DEPENDENCY_PROXY_SERVER', value: "#{Gitlab.config.gitlab.host}:#{Gitlab.config.gitlab.port}", public: true, masked: false },
@@ -2415,7 +2416,6 @@ RSpec.describe Ci::Build do
           { key: 'CI_API_V4_URL', value: 'http://localhost/api/v4', public: true, masked: false },
           { key: 'CI_PIPELINE_IID', value: pipeline.iid.to_s, public: true, masked: false },
           { key: 'CI_PIPELINE_SOURCE', value: pipeline.source, public: true, masked: false },
-          { key: 'CI_CONFIG_PATH', value: pipeline.config_path, public: true, masked: false },
           { key: 'CI_COMMIT_SHA', value: build.sha, public: true, masked: false },
           { key: 'CI_COMMIT_SHORT_SHA', value: build.short_sha, public: true, masked: false },
           { key: 'CI_COMMIT_BEFORE_SHA', value: build.before_sha, public: true, masked: false },

spec/models/ci/pipeline_spec.rb

@@ -807,7 +807,6 @@ RSpec.describe Ci::Pipeline, :mailer, factory_default: :keep do
       expect(keys).to eq %w[
         CI_PIPELINE_IID
         CI_PIPELINE_SOURCE
-        CI_CONFIG_PATH
         CI_COMMIT_SHA
         CI_COMMIT_SHORT_SHA
         CI_COMMIT_BEFORE_SHA

spec/models/project_spec.rb

@@ -4466,7 +4466,11 @@ RSpec.describe Project, factory_default: :keep do
     subject { project.predefined_project_variables.to_runner_variables }
 
     specify do
-      expect(subject).to include({ key: 'CI_PROJECT_CONFIG_PATH', value: Ci::Pipeline::DEFAULT_CONFIG_PATH, public: true, masked: false })
+      expect(subject).to include
+      [
+        { key: 'CI_PROJECT_CONFIG_PATH', value: Ci::Pipeline::DEFAULT_CONFIG_PATH, public: true, masked: false },
+        { key: 'CI_CONFIG_PATH', value: Ci::Pipeline::DEFAULT_CONFIG_PATH, public: true, masked: false }
+      ]
     end
 
     context 'when ci config path is overridden' do
@@ -4474,7 +4478,13 @@ RSpec.describe Project, factory_default: :keep do
         project.update!(ci_config_path: 'random.yml')
       end
 
-      it { expect(subject).to include({ key: 'CI_PROJECT_CONFIG_PATH', value: 'random.yml', public: true, masked: false }) }
+      it do
+        expect(subject).to include
+        [
+          { key: 'CI_PROJECT_CONFIG_PATH', value: 'random.yml', public: true, masked: false },
+          { key: 'CI_CONFIG_PATH', value: 'random.yml', public: true, masked: false }
+        ]
+      end
     end
   end