[JENKINS-43052] Warn if a deprecated extension is used in Pipeline (#3905)

* Warn in Pipeline when RelativeTargetDirectory extension is used

* Warn in Pipeline when deprecated polling extensions are used

* Warn in Pipeline when deprecated polling and message exclusion extensions are used

* Warn in Pipeline build log when PreBuildMerge extension is used

* Warn in Pipeline build log when WipeWorkspace extension is used

* [JENKINS-43052] Standardize Pipeline deprecation warnings to DEPRECATED prefix

* Add Pipeline Workflow tests for deprecated GitSCM extensions

* Guard against null Run in PreBuildMerge.decorateRevisionToBuild

* Use consistent spacing

* Add comment explaining why instanceof is not used

* Use scmGit() in a block quote for easier reading of test source

* Use more precise assertion of expected deprecation message

* Improve Pipeline deprecation Workflow tests and align warnings

* Normalize sampleRepo path in Workflow tests for Windows compatibility

* Reduce diffs to master branch

* Escape backslash in test repository path

* Use beforeCheckout to warn on each deprecated extension

Consistent coding pattern and avoids the need for a variable to decide if
the message has been displayed.  Messages will be displayed each checkout.

Still needs test for message exclusion deprecation and for requires
workspace polling deprecation.

* Add a message exclusion workflow test

* Add a disable remote polling workflow test

* Remove duplicated test

---------

Co-authored-by: Mark Waite <[email protected]>

Author: Nimbusprogrammer

src/main/java/hudson/plugins/git/extensions/GitSCMExtension.java

@@ -161,6 +161,9 @@ public Revision decorateRevisionToBuild(GitSCM scm, AbstractBuild<?,?> build, Gi
      * @throws GitException on git error
      */
     public void beforeCheckout(GitSCM scm, Run<?,?> build, GitClient git, TaskListener listener) throws IOException, InterruptedException, GitException {
+        if (requiresWorkspaceForPolling() && build != null && build.getClass().getName().startsWith("org.jenkinsci.plugins.workflow.job.")) {
+            listener.getLogger().println("DEPRECATED: The extension that requires a workspace for polling is deprecated for Pipeline jobs. " + "Use Pipeline-native SCM polling instead.");
+        }
         if (build instanceof AbstractBuild<?,?> abstractBuild && listener instanceof BuildListener buildListener) {
             beforeCheckout(scm, abstractBuild, git, buildListener);
         }

src/main/java/hudson/plugins/git/extensions/impl/MessageExclusion.java

@@ -2,6 +2,7 @@
 
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import hudson.Extension;
+import hudson.model.Run;
 import hudson.model.TaskListener;
 import hudson.plugins.git.GitChangeSet;
 import hudson.plugins.git.GitException;
@@ -54,6 +55,16 @@ public Boolean isRevExcluded(GitSCM scm, GitClient git, GitChangeSet commit, Tas
 		return null;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override
+	public void beforeCheckout(GitSCM scm, Run<?, ?> build, GitClient git, TaskListener listener) throws IOException, InterruptedException, GitException {
+		if (build != null && build.getClass().getName().startsWith("org.jenkinsci.plugins.workflow.job.")) {
+			listener.getLogger().println("DEPRECATED: Message exclusion during polling is deprecated for Pipeline jobs. " + "Use the Pipeline SCM trait instead.");
+		}
+	}
+
 	@Extension
         // No @Symbol annotation because message exclusion is done using a trait in Pipeline
 	public static class DescriptorImpl extends GitSCMExtensionDescriptor {

src/main/java/hudson/plugins/git/extensions/impl/PreBuildMerge.java

@@ -132,6 +132,16 @@ public void decorateMergeCommand(GitSCM scm, Run<?, ?> build, GitClient git, Tas
         cmd.setGitPluginFastForwardMode(options.getFastForwardMode());
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void beforeCheckout(GitSCM scm, Run<?, ?> build, GitClient git, TaskListener listener) throws IOException, InterruptedException, GitException {
+        if (build != null && build.getClass().getName().startsWith("org.jenkinsci.plugins.workflow.job.")) {
+            listener.getLogger().println("DEPRECATED: The 'Merge before build' extension is deprecated for Pipeline jobs. " + "Pipeline users should perform merges explicitly using shell steps (e.g. sh 'git merge').");
+        }
+    }
+
     @Override
     public GitClientType getRequiredClient() {
         return GitClientType.GITCLI;

src/main/java/hudson/plugins/git/extensions/impl/RelativeTargetDirectory.java

@@ -4,12 +4,14 @@
 import hudson.Extension;
 import hudson.FilePath;
 import hudson.model.Job;
+import hudson.model.Run;
 import hudson.model.TaskListener;
 import hudson.plugins.git.GitException;
 import hudson.plugins.git.GitSCM;
 import hudson.plugins.git.Messages;
 import hudson.plugins.git.extensions.GitSCMExtension;
 import hudson.plugins.git.extensions.GitSCMExtensionDescriptor;
+import org.jenkinsci.plugins.gitclient.GitClient;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.io.IOException;
@@ -33,6 +35,16 @@ public String getRelativeTargetDir() {
         return relativeTargetDir;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void beforeCheckout(GitSCM scm, Run<?, ?> build, GitClient git, TaskListener listener) throws IOException, InterruptedException, GitException {
+        if (build != null && build.getClass().getName().startsWith("org.jenkinsci.plugins.workflow.job.")) {
+            listener.getLogger().println("DEPRECATED: Relative target directory is deprecated for Pipeline jobs. " + "Use the 'dir' step instead.");
+        }
+    }
+
     @Override
     public FilePath getWorkingDirectory(GitSCM scm, Job<?, ?> context, FilePath workspace, EnvVars environment, TaskListener listener) throws IOException, InterruptedException, GitException {
         if (relativeTargetDir == null || relativeTargetDir.length() == 0 || relativeTargetDir.equals(".")) {

src/main/java/hudson/plugins/git/extensions/impl/WipeWorkspace.java

@@ -26,6 +26,10 @@ public WipeWorkspace() {
      */
     @Override
     public void beforeCheckout(GitSCM scm, Run<?, ?> build, GitClient git, TaskListener listener) throws IOException, InterruptedException, GitException {
+        if (build != null && build.getClass().getName().startsWith("org.jenkinsci.plugins.workflow.job.")) {
+            listener.getLogger().println("DEPRECATED: The 'Wipe out repository & force clone' extension is deprecated for Pipeline jobs. " + "Pipeline users should use the deleteDir() step instead.");
+        }
+
         listener.getLogger().println("Wiping out workspace first.");
         git.getWorkTree().deleteContents();
     }

src/test/java/hudson/plugins/git/extensions/impl/DeprecatedPollingExtensionsWorkflowTest.java

@@ -0,0 +1,52 @@
+package hudson.plugins.git.extensions.impl;
+
+import jenkins.plugins.git.GitSampleRepoRule;
+import jenkins.plugins.git.junit.jupiter.WithGitSampleRepo;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+@WithJenkins
+@WithGitSampleRepo
+class DeprecatedPollingExtensionsWorkflowTest {
+
+        @Test
+        void disableRemotePollTriggersDeprecatedWarning(
+                JenkinsRule r,
+                GitSampleRepoRule sampleRepo
+        ) throws Exception {
+
+                sampleRepo.init();
+
+                WorkflowJob job =
+                        r.jenkins.createProject(WorkflowJob.class,
+                                "disable-remote-poll-deprecated-warning");
+
+                job.setDefinition(new CpsFlowDefinition(
+                        """
+                        node {
+                          checkout(
+                            scmGit(
+                              extensions: [[
+                                $class: 'DisableRemotePoll'
+                              ]],
+                              userRemoteConfigs: [[url: '%s']]
+                            )
+                          )
+                        }
+                        """.formatted(sampleRepo.toString().replace("\\", "\\\\")),
+                        true
+                ));
+
+                WorkflowRun run = r.buildAndAssertSuccess(job);
+
+                r.waitForMessage(
+                        "DEPRECATED: The extension that requires a workspace for polling is deprecated for Pipeline jobs. "
+                                + "Use Pipeline-native SCM polling instead.",
+                        run
+                );
+        }
+}

src/test/java/hudson/plugins/git/extensions/impl/MessageExclusionWorkflowTest.java

@@ -0,0 +1,53 @@
+package hudson.plugins.git.extensions.impl;
+
+import jenkins.plugins.git.GitSampleRepoRule;
+import jenkins.plugins.git.junit.jupiter.WithGitSampleRepo;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+@WithJenkins
+@WithGitSampleRepo
+class MessageExclusionWorkflowTest {
+
+        @Test
+        void messageExclusionTriggersDeprecatedWarning(
+                JenkinsRule r,
+                GitSampleRepoRule sampleRepo
+        ) throws Exception {
+
+                sampleRepo.init();
+
+                WorkflowJob job =
+                        r.jenkins.createProject(WorkflowJob.class,
+                                "message-exclusion-deprecated-warning");
+
+                job.setDefinition(new CpsFlowDefinition(
+                        """
+                        node {
+                          checkout(
+                            scmGit(
+                              extensions: [[
+                                $class: 'MessageExclusion',
+                                excludedMessage: 'excluded-message'
+                              ]],
+                              userRemoteConfigs: [[url: '%s']]
+                            )
+                          )
+                        }
+                        """.formatted(sampleRepo.toString().replace("\\", "\\\\")),
+                        true
+                ));
+
+                WorkflowRun run = r.buildAndAssertSuccess(job);
+
+                r.waitForMessage(
+                        "DEPRECATED: Message exclusion during polling is deprecated for Pipeline jobs. "
+                                + "Use the Pipeline SCM trait instead.",
+                        run
+                );
+        }
+}

src/test/java/hudson/plugins/git/extensions/impl/PreBuildMergeWorkflowTest.java

@@ -0,0 +1,56 @@
+package hudson.plugins.git.extensions.impl;
+
+import jenkins.plugins.git.GitSampleRepoRule;
+import jenkins.plugins.git.junit.jupiter.WithGitSampleRepo;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+@WithJenkins
+@WithGitSampleRepo
+class PreBuildMergeWorkflowTest {
+
+    @Test
+    void preBuildMergeTriggersDeprecatedWarning(
+            JenkinsRule r,
+            GitSampleRepoRule sampleRepo
+    ) throws Exception {
+
+        sampleRepo.init();
+
+        WorkflowJob job =
+                r.jenkins.createProject(WorkflowJob.class,
+                        "pre-build-merge-deprecated-warning");
+
+        job.setDefinition(new CpsFlowDefinition(
+                """
+                node {
+                  checkout(
+                    scmGit(
+                      extensions: [[
+                        $class: 'PreBuildMerge',
+                        options: [
+                          mergeRemote: 'origin',
+                          mergeTarget: 'master'
+                        ]
+                      ]],
+                      userRemoteConfigs: [[url: '%s']]
+                    )
+                  )
+                }
+                """.formatted(sampleRepo.toString().replace("\\", "\\\\")),
+                true
+        ));
+
+        WorkflowRun run = r.buildAndAssertSuccess(job);
+
+        r.waitForMessage(
+                "DEPRECATED: The 'Merge before build' extension is deprecated for Pipeline jobs. "
+                        + "Pipeline users should perform merges explicitly using shell steps (e.g. sh 'git merge').",
+                run
+        );
+    }
+}

src/test/java/hudson/plugins/git/extensions/impl/RelativeTargetDirectoryWorkflowTest.java

@@ -0,0 +1,53 @@
+package hudson.plugins.git.extensions.impl;
+
+import jenkins.plugins.git.GitSampleRepoRule;
+import jenkins.plugins.git.junit.jupiter.WithGitSampleRepo;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+@WithJenkins
+@WithGitSampleRepo
+class RelativeTargetDirectoryWorkflowTest {
+
+    @Test
+    void relativeTargetDirectoryTriggersDeprecatedWarning(
+            JenkinsRule r,
+            GitSampleRepoRule sampleRepo
+    ) throws Exception {
+
+        sampleRepo.init();
+
+        WorkflowJob job =
+                r.jenkins.createProject(WorkflowJob.class,
+                        "relative-target-directory-deprecated-warning");
+
+        job.setDefinition(new CpsFlowDefinition(
+                """
+                node {
+                  checkout(
+                    scmGit(
+                      extensions: [[
+                        $class: 'RelativeTargetDirectory',
+                        relativeTargetDir: 'subdir'
+                      ]],
+                      userRemoteConfigs: [[url: '%s']]
+                    )
+                  )
+                }
+                """.formatted(sampleRepo.toString().replace("\\", "\\\\")),
+                true
+        ));
+
+        WorkflowRun run = r.buildAndAssertSuccess(job);
+
+        r.waitForMessage(
+                "DEPRECATED: Relative target directory is deprecated for Pipeline jobs. "
+                        + "Use the 'dir' step instead.",
+                run
+        );
+    }
+}

src/test/java/hudson/plugins/git/extensions/impl/WipeWorkspaceWorkflowTest.java

@@ -0,0 +1,52 @@
+package hudson.plugins.git.extensions.impl;
+
+import jenkins.plugins.git.GitSampleRepoRule;
+import jenkins.plugins.git.junit.jupiter.WithGitSampleRepo;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+@WithJenkins
+@WithGitSampleRepo
+class WipeWorkspaceWorkflowTest {
+
+        @Test
+        void wipeWorkspaceTriggersDeprecatedWarning(
+                JenkinsRule r,
+                GitSampleRepoRule sampleRepo
+        ) throws Exception {
+
+                sampleRepo.init();
+
+                WorkflowJob job =
+                        r.jenkins.createProject(WorkflowJob.class,
+                                "wipe-workspace-deprecated-warning");
+
+                job.setDefinition(new CpsFlowDefinition(
+                        """
+                        node {
+                          checkout(
+                            scmGit(
+                              extensions: [[
+                                $class: 'WipeWorkspace'
+                              ]],
+                              userRemoteConfigs: [[url: '%s']]
+                            )
+                          )
+                        }
+                        """.formatted(sampleRepo.toString().replace("\\", "\\\\")),
+                        true
+                ));
+
+                WorkflowRun run = r.buildAndAssertSuccess(job);
+
+                r.waitForMessage(
+                        "DEPRECATED: The 'Wipe out repository & force clone' extension is deprecated for Pipeline jobs. "
+                                + "Pipeline users should use the deleteDir() step instead.",
+                        run
+                );
+        }
+}