Test coverage for input step (jenkinsci#786)

Co-authored-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>

Author: timja

src/test/java/io/jenkins/plugins/pipelinegraphview/consoleview/PipelineConsoleViewInputTest.java

@@ -0,0 +1,76 @@
+package io.jenkins.plugins.pipelinegraphview.consoleview;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.junit.UsePlaywright;
+import hudson.model.Result;
+import io.jenkins.plugins.casc.misc.ConfiguredWithCode;
+import io.jenkins.plugins.casc.misc.JenkinsConfiguredWithCodeRule;
+import io.jenkins.plugins.casc.misc.junit.jupiter.WithJenkinsConfiguredWithCode;
+import io.jenkins.plugins.pipelinegraphview.playwright.PipelineJobPage;
+import io.jenkins.plugins.pipelinegraphview.playwright.PipelineOverviewPage;
+import io.jenkins.plugins.pipelinegraphview.playwright.PlaywrightConfig;
+import io.jenkins.plugins.pipelinegraphview.utils.TestUtils;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+@WithJenkinsConfiguredWithCode
+@UsePlaywright(PlaywrightConfig.class)
+class PipelineConsoleViewInputTest {
+
+    @Test
+    @ConfiguredWithCode("../configure-appearance.yml")
+    void inputWithParametersSucceeds(Page p, JenkinsConfiguredWithCodeRule j) throws Exception {
+        WorkflowRun run = TestUtils.createAndRunJobNoWait(
+                        j, "input-with-parameters", "input-with-parameters.jenkinsfile")
+                .waitForStart();
+        new PipelineJobPage(p, run.getParent())
+                .goTo()
+                .hasBuilds(1)
+                .nthBuild(0)
+                .goToBuild()
+                .goToPipelineOverview()
+                .clickInputWithParameters()
+                .enterText("Hi there!")
+                .proceed();
+        j.assertBuildStatus(Result.SUCCESS, j.waitForCompletion(run));
+    }
+
+    @Test
+    @ConfiguredWithCode("../configure-appearance.yml")
+    void inputSucceeds(Page p, JenkinsConfiguredWithCodeRule j) throws Exception {
+        WorkflowRun run =
+                TestUtils.createAndRunJobNoWait(j, "input", "input.jenkinsfile").waitForStart();
+
+        new PipelineJobPage(p, run.getParent())
+                .goTo()
+                .hasBuilds(1)
+                .nthBuild(0)
+                .goToBuild()
+                .goToPipelineOverview()
+                .clickProceed();
+
+        j.assertBuildStatus(Result.SUCCESS, j.waitForCompletion(run));
+    }
+
+    @Test
+    @ConfiguredWithCode("../configure-appearance.yml")
+    @Disabled("https://github.com/jenkinsci/pipeline-graph-view-plugin/issues/568")
+    void inputSucceedsWithDelay(Page p, JenkinsConfiguredWithCodeRule j) throws Exception {
+        WorkflowRun run =
+                TestUtils.createAndRunJobNoWait(j, "input", "input.jenkinsfile").waitForStart();
+
+        PipelineOverviewPage pipelineOverviewPage = new PipelineJobPage(p, run.getParent())
+                .goTo()
+                .hasBuilds(1)
+                .nthBuild(0)
+                .goToBuild()
+                .goToPipelineOverview();
+
+        // Fails if you don't click proceed immediately currently
+        p.waitForTimeout(1000D);
+
+        pipelineOverviewPage.clickProceed();
+        j.assertBuildStatus(Result.SUCCESS, j.waitForCompletion(run));
+    }
+}

src/test/java/io/jenkins/plugins/pipelinegraphview/playwright/InputPage.java

@@ -0,0 +1,26 @@
+package io.jenkins.plugins.pipelinegraphview.playwright;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.options.AriaRole;
+
+public class InputPage extends JenkinsPage<InputPage> {
+
+    protected InputPage(Page page, String baseUrl) {
+        super(page, baseUrl + "input/");
+    }
+
+    public InputPage enterText(String input) {
+        page.getByRole(AriaRole.TEXTBOX).fill(input);
+        return this;
+    }
+
+    public void proceed() {
+        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("proceed"))
+                .click();
+    }
+
+    public void abort() {
+        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("abort"))
+                .click();
+    }
+}

src/test/java/io/jenkins/plugins/pipelinegraphview/playwright/OverviewTree.java

@@ -100,4 +100,12 @@ public void stageIsVisible(String stage) {
         Locator found = getStageByName(stage);
         assertThat(found).isVisible();
     }
+
+    public void clickProceed() {
+        this.page.getByText("Proceed").click();
+    }
+
+    public void clickInputWithParameters() {
+        this.page.getByText("Input requested").click();
+    }
 }

src/test/java/io/jenkins/plugins/pipelinegraphview/playwright/PipelineOverviewPage.java

@@ -15,10 +15,12 @@ public class PipelineOverviewPage extends JenkinsPage<PipelineOverviewPage> {
     private final PipelineGraph graph;
     private final OverviewTree tree;
     private final PipelineConsole logs;
+    private final String jobUrl;
 
     public PipelineOverviewPage(Page page, String jobUrl, String buildName) {
         super(page, jobUrl + "pipeline-overview/");
         this.buildName = buildName;
+        this.jobUrl = jobUrl;
         graph = new PipelineGraph(page.locator(".PWGx-PipelineGraph-container"));
         tree = new OverviewTree(page.locator("#tree-view-pane"));
         logs = new PipelineConsole(page.locator("#stage-view-pane"));
@@ -113,6 +115,17 @@ public PipelineOverviewPage stageHasStateInLogs(String stage, PipelineState stat
         return this;
     }
 
+    public InputPage clickInputWithParameters() {
+        tree.clickInputWithParameters();
+
+        return new InputPage(page, jobUrl).waitForLoaded();
+    }
+
+    public PipelineOverviewPage clickProceed() {
+        tree.clickProceed();
+        return this;
+    }
+
     public PipelineOverviewPage clearSearch() {
         tree.clearSearch();
         return this;

src/test/resources/io/jenkins/plugins/pipelinegraphview/utils/input-with-parameters.jenkinsfile

@@ -0,0 +1,10 @@
+pipeline {
+    agent any
+    stages {
+        stage('Input') {
+            steps {
+                input message: 'Shall we continue?', parameters: [string('Hello'), booleanParam('boolean-value')]
+            }
+        }
+    }
+}

src/test/resources/io/jenkins/plugins/pipelinegraphview/utils/input.jenkinsfile

@@ -0,0 +1,10 @@
+pipeline {
+    agent any
+    stages {
+        stage('Input') {
+            steps {
+                input 'Do you allow this?'
+            }
+        }
+    }
+}