pipelines = api.isPresent() ? api.get().listPipelines(program) : Collections.emptyList();
94 | for (Pipeline p : pipelines) {
95 | lbm.add(p.getName(), p.getId());
96 | }
97 | } catch (CloudManagerApiException e) {
98 | LOGGER.error(Messages.DescriptorHelper_error_CloudManagerApiException(e.getLocalizedMessage()));
99 | }
100 | }
101 | return lbm;
102 | }
103 | }
104 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/step/PollPipelineStep.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.step;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.util.Arrays;
30 | import java.util.Collections;
31 | import java.util.HashSet;
32 | import java.util.Set;
33 | import javax.annotation.Nonnull;
34 |
35 | import hudson.Extension;
36 | import hudson.model.Run;
37 | import hudson.model.TaskListener;
38 | import io.jenkins.plugins.adobe.cloudmanager.step.execution.PollPipelineExecution;
39 | import org.jenkinsci.plugins.workflow.steps.Step;
40 | import org.jenkinsci.plugins.workflow.steps.StepContext;
41 | import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
42 | import org.jenkinsci.plugins.workflow.steps.StepExecution;
43 | import org.kohsuke.stapler.DataBoundConstructor;
44 | import org.kohsuke.stapler.DataBoundSetter;
45 |
46 | /**
47 | * Polls the Cloud Manager API to determine if the pipeline has completed.
48 | *
49 | * The pipeline execution needs to be in the Job/Build context.
50 | *
51 | */
52 | public class PollPipelineStep extends Step {
53 |
54 | /**
55 | * Minimum time to wait before poll checks.
56 | */
57 | static final long MIN_RECURRENCE_PERIOD = 30000; // 30 seconds
58 | /**
59 | * Maximum time to wait before poll checks.
60 | */
61 | static final long MAX_RECURRENCE_PERIOD = 900000; // 15 minutes
62 | /**
63 | * Default time to wait before poll checks.
64 | */
65 | static final long DEFAULT_RECURRENCE_PERIOD = 300000; // 5 minutes
66 |
67 | private long recurrencePeriod = DEFAULT_RECURRENCE_PERIOD;
68 | private boolean quiet = false;
69 |
70 | @DataBoundConstructor
71 | public PollPipelineStep() {
72 | }
73 |
74 | /**
75 | * Wait period before repeated API checks, in milliseconds
76 | */
77 | public long getRecurrencePeriod() {
78 | return recurrencePeriod;
79 | }
80 |
81 | @DataBoundSetter
82 | public void setRecurrencePeriod(long recurrencePeriod) {
83 | this.recurrencePeriod = Math.max(MIN_RECURRENCE_PERIOD, Math.min(recurrencePeriod, MAX_RECURRENCE_PERIOD));
84 | }
85 |
86 | /**
87 | * Flag to indicate whether or not this step should log each API check.
88 | */
89 | public boolean isQuiet() {
90 | return quiet;
91 | }
92 |
93 | @DataBoundSetter
94 | public void setQuiet(boolean quiet) {
95 | this.quiet = quiet;
96 | }
97 |
98 | @Override
99 | public StepExecution start(StepContext context) throws Exception {
100 | return new PollPipelineExecution(context, recurrencePeriod, quiet);
101 | }
102 |
103 | @Extension
104 | public static final class DescriptorImpl extends StepDescriptor {
105 |
106 | @Override
107 | public String getFunctionName() {
108 | return "acmPollPipeline";
109 | }
110 |
111 | @Nonnull
112 | @Override
113 | public String getDisplayName() {
114 | return Messages.PollPipelineStep_displayName();
115 | }
116 |
117 | @Override
118 | public Set> getRequiredContext() {
119 | return Collections.unmodifiableSet(new HashSet<>(Arrays.asList(Run.class, TaskListener.class)));
120 | }
121 | }
122 | }
123 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/step/PipelineEndStep.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.step;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.util.Arrays;
30 | import java.util.Collections;
31 | import java.util.HashSet;
32 | import java.util.Set;
33 | import javax.annotation.Nonnull;
34 |
35 | import hudson.Extension;
36 | import hudson.model.Run;
37 | import hudson.model.TaskListener;
38 | import io.jenkins.plugins.adobe.cloudmanager.step.execution.PipelineEndExecution;
39 | import org.jenkinsci.plugins.workflow.graph.FlowNode;
40 | import org.jenkinsci.plugins.workflow.steps.Step;
41 | import org.jenkinsci.plugins.workflow.steps.StepContext;
42 | import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
43 | import org.jenkinsci.plugins.workflow.steps.StepExecution;
44 | import org.kohsuke.stapler.DataBoundConstructor;
45 | import org.kohsuke.stapler.DataBoundSetter;
46 |
47 | /**
48 | * {@link Step} which waits for a Cloud Manager pipeline end event.
49 | *
50 | * If an Pipeline end event is received, all inner {@link PipelineStepStateStep} instances are quietly ended.
51 | * Any other inner steps are allowed to complete as configured.
52 | *
53 | *
54 | * See the Cloud Manager Events documentation.
55 | *
56 | *
57 | * Note: Syntax wise, until JENKINS-65646 is resolved, a block must be specified, even if its empty.
58 | *
59 | */
60 | public class PipelineEndStep extends Step {
61 |
62 | private boolean mirror = true;
63 | private boolean empty = false;
64 |
65 | @DataBoundConstructor
66 | public PipelineEndStep() {
67 |
68 | }
69 |
70 | /**
71 | * Flag if this step mirror the remote state. (Remote aborted results in local failure.)
72 | */
73 | public boolean isMirror() {
74 | return mirror;
75 | }
76 |
77 | @DataBoundSetter
78 | public void setMirror(boolean mirror) {
79 | this.mirror = mirror;
80 | }
81 |
82 | public boolean isEmpty() { return empty; }
83 |
84 | @DataBoundSetter
85 | public void setEmpty(boolean empty) { this.empty = empty; }
86 |
87 | @Override
88 | public StepExecution start(StepContext context) throws Exception {
89 | return new PipelineEndExecution(context, mirror, empty);
90 | }
91 |
92 | @Extension
93 | public static final class DescriptorImpl extends StepDescriptor {
94 |
95 | @Override
96 | public String getFunctionName() {
97 | return "acmPipelineEnd";
98 | }
99 |
100 | @Override
101 | public Set> getRequiredContext() {
102 | return Collections.unmodifiableSet(new HashSet<>(Arrays.asList(Run.class, FlowNode.class, TaskListener.class)));
103 | }
104 |
105 | @Nonnull
106 | @Override
107 | public String getDisplayName() {
108 | return Messages.PipelineEndStep_displayName();
109 | }
110 |
111 | @Override
112 | public boolean takesImplicitBlockArgument() {
113 | return true;
114 | }
115 | }
116 | }
117 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Adobe Cloud Manager plugin for Jenkins
2 |
3 | [](https://ci.jenkins.io/job/Plugins/job/adobe-cloud-manager-plugin/job/master/)
4 | [](https://plugins.jenkins.io/adobe-cloud-manager)
5 | [](https://github.com/jenkinsci/adobe-cloud-manager-plugin/releases/latest)
6 | [](https://plugins.jenkins.io/adobe-cloud-manager)
7 |
8 | - [Introduction](#introduction)
9 | - [Getting Started](#getting-started)
10 | - [Usage](#usage)
11 | - [Build Actions](#build-actions)
12 | - [Examples](#examples)
13 |
14 | ## Introduction
15 |
16 | This plugin is intended to allow teams to integrate their Adobe Cloud Manager release process with upstream, intermediate and downstream operational tasks. It provides mechanisms for activating builds, responding to AdobeIO Cloud Manager build events, and taking actions during approval steps.
17 |
18 | ## Versions
19 |
20 | This plugin uses automatic releases, which has a different version format. See https://www.jenkins.io/jep/229
21 |
22 | ## Getting Started
23 |
24 | Before using any of the builders or steps in this plugin, Jenkins needs to be configured to authenticate to an Adobe IO project. To do that, follow these steps:
25 |
26 | 1. [Create an Adobe IO API Integration](https://www.adobe.io/apis/experiencecloud/cloud-manager/docs.html#!AdobeDocs/cloudmanager-api-docs/master/create-api-integration.md).
27 | 1. [Add the credentials to Jenkins](/doc/config/jenkins-credentials/README.md)
28 | 1. [Configure an Adobe IO Project](/doc/config/adobeio-project/README.md)
29 |
30 | ### AdobeIO WebHook
31 |
32 | This plugin supports receiving AdobeIO Cloud Manager events. See the [Adobe IO Project configuration](/doc/config/adobeio-project/README.md#enable-webhook) for details on the WebHook operation, and the [Adobe IO documentation](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/intro/webhooks_intro.md) on configuring a webhook endpoint.
33 |
34 | ## Usage
35 |
36 | The following builders and steps are available in this plugin. See the individual details page on how each functions and how to configure.
37 |
38 | All of the items listed here support syntax generation using the in-Jenkins *Pipeline Syntax* tool.
39 |
40 | ## Triggers
41 |
42 | - [Start Pipeline Trigger](/doc/trigger/start-pipeline/README.md)
43 |
44 | ## Steps/Builders
45 |
46 | - [Repository Sync Builder](/doc/builder/repository-sync/README.md)
47 | - [Start Pipeline Builder](/doc/builder/start-pipeline/README.md)
48 | - [Poll Pipeline Step](/doc/step/poll-pipeline/README.md)
49 | - [Pipeline Step Execution Step](/doc/step/pipeline-step-state/README.md)
50 | - [Pipeline End Execution Step](/doc/step/pipeline-end/README.md)
51 |
52 | ## Build Actions
53 |
54 | - [Cloud Manager Build](/doc/action/cloud-manager-build/README.md)
55 | - [Pipeline Waiting](/doc/action/pipeline-waiting/README.md)
56 |
57 | ## Examples
58 |
59 | Coming soon.
60 |
61 | ## Issues
62 |
63 | Report issues and enhancements in the [Jenkins issue tracker](https://issues.jenkins.io/issues/?jql=project%20%3D%20JENKINS%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20adobe-cloud-manager-plugin). The Component is `adobe-cloud-manager-plugin`.
64 |
65 | ## Contributing
66 |
67 | Refer to the general Jenkins. [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md).
68 |
69 | ### Code Submissions
70 |
71 | Submissions should come as pull request and will be reviewed by project committers.
72 |
73 | ### License Headers
74 |
75 | Please make sure to run the license header profile before creating a pull request. This can be done with:
76 |
77 | > $ mvn clean process-sources process-test-resources -Plicense-header-check
78 |
79 | This will tell you of any files with missing license headers.
80 |
81 | ## LICENSE
82 |
83 | Licensed under MIT, see [LICENSE](LICENSE)
84 |
85 | ## SUPPORT
86 |
87 | The Adobe Cloud Manager Jenkins Plugin is an open-source, community supported library.
88 |
89 | The Adobe Cloud Manager Jenkins Plugin NOT supported or warrantied by Adobe Systems Inc.
90 |
91 | For reporting bugs, contributing, or other questions about this project, please see the [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md).
92 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/adobe/cloudmanager/step/execution/AbstractStepExecutionTest.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.step.execution;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import hudson.AbortException;
30 | import hudson.model.Run;
31 | import io.adobe.cloudmanager.CloudManagerApi;
32 | import io.jenkins.plugins.adobe.cloudmanager.CloudManagerPipelineExecution;
33 | import io.jenkins.plugins.adobe.cloudmanager.action.CloudManagerBuildAction;
34 | import io.jenkins.plugins.adobe.cloudmanager.config.AdobeIOConfig;
35 | import io.jenkins.plugins.adobe.cloudmanager.config.AdobeIOProjectConfig;
36 | import mockit.Expectations;
37 | import mockit.Injectable;
38 | import mockit.Mock;
39 | import mockit.MockUp;
40 | import mockit.Mocked;
41 | import mockit.Tested;
42 | import org.jenkinsci.plugins.workflow.steps.StepContext;
43 | import org.junit.Before;
44 | import org.junit.Test;
45 | import static org.junit.Assert.*;
46 |
47 | public class AbstractStepExecutionTest {
48 |
49 | private static final String found = "Found Config";
50 |
51 | @Tested
52 | private AbstractStepExecution tested;
53 |
54 | @Injectable
55 | private StepContext context;
56 |
57 | @Mocked
58 | private Run run;
59 |
60 | @Mocked
61 | private CloudManagerBuildAction data;
62 |
63 | @Mocked
64 | private CloudManagerPipelineExecution cmExecution;
65 |
66 | @Mocked
67 | private CloudManagerApi api;
68 |
69 | @Mocked
70 | private AdobeIOProjectConfig projectConfig;
71 |
72 | @Before
73 | public void before() throws Exception {
74 | new MockUp() {
75 | @Mock
76 | public AdobeIOProjectConfig projectConfigFor(String name) {
77 | return found.equals(name) ? projectConfig : null;
78 | }
79 | };
80 | new Expectations() {{
81 | context.get(Run.class);
82 | result = run;
83 | minTimes = 0;
84 | run.getAction(CloudManagerBuildAction.class);
85 | result = data;
86 | minTimes = 0;
87 | }};
88 | }
89 |
90 | @Test
91 | public void validateMissingAIOProject() throws Exception {
92 | new Expectations() {{
93 | data.getAioProjectName();
94 | result = "Missing";
95 | }};
96 | assertThrows(AbortException.class, () -> tested.validateData());
97 | }
98 |
99 | @Test
100 | public void validateMissingCMExecution() throws Exception {
101 | new Expectations() {{
102 | data.getAioProjectName();
103 | result = found;
104 | data.getCmExecution();
105 | result = null;
106 | }};
107 | assertThrows(AbortException.class, () -> tested.validateData());
108 | }
109 |
110 | @Test
111 | public void validateSuccess() throws Exception {
112 | new Expectations() {{
113 | data.getAioProjectName();
114 | result = found;
115 | data.getCmExecution();
116 | result = cmExecution;
117 | }};
118 | tested.validateData();
119 | }
120 |
121 | @Test
122 | public void projectMissing() throws Exception {
123 | new Expectations() {{
124 | data.getAioProjectName();
125 | result = "Missing";
126 | }};
127 | assertThrows(AbortException.class, () -> tested.getAioProject());
128 | }
129 |
130 | @Test
131 | public void projectFound() throws Exception {
132 | new Expectations() {{
133 | data.getAioProjectName();
134 | result = found;
135 | }};
136 | assertNotNull(tested.getAioProject());
137 | }
138 | }
139 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/adobe/cloudmanager/config/ConfigAsCodeTest.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.config;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.util.List;
30 |
31 | import io.jenkins.plugins.casc.ConfigurationContext;
32 | import io.jenkins.plugins.casc.Configurator;
33 | import io.jenkins.plugins.casc.ConfiguratorRegistry;
34 | import io.jenkins.plugins.casc.misc.ConfiguredWithCode;
35 | import io.jenkins.plugins.casc.misc.JenkinsConfiguredWithCodeRule;
36 | import io.jenkins.plugins.casc.model.CNode;
37 | import io.jenkins.plugins.casc.model.Mapping;
38 | import org.junit.Rule;
39 | import org.junit.Test;
40 | import static org.junit.Assert.*;
41 |
42 | public class ConfigAsCodeTest {
43 |
44 | @Rule
45 | public JenkinsConfiguredWithCodeRule rule = new JenkinsConfiguredWithCodeRule();
46 |
47 | @Test
48 | @ConfiguredWithCode("configuration-as-code.yaml")
49 | public void shouldSupportConfigurationAsCode() {
50 | AdobeIOConfig aioconfig = AdobeIOConfig.configuration();
51 |
52 | assertEquals("Configurations were loaded", 2, aioconfig.getProjectConfigs().size());
53 |
54 | AdobeIOProjectConfig config = aioconfig.getProjectConfigs().get(0);
55 | assertEquals("Name is correct.", "Test Project 1", config.getName());
56 | assertEquals("API URL is correct.", AdobeIOProjectConfig.ADOBE_IO_URL, config.getApiUrl());
57 | assertEquals("Client Id is correct", "Client Id 1", config.getClientId());
58 | assertEquals("IMS Org is correct", "Ims Organization Id 1", config.getImsOrganizationId());
59 | assertEquals("Tech Account is correct", "Technical Account Id 1", config.getTechnicalAccountId());
60 | assertEquals("Client Secret Cred is correct", "Client Secret Credentials Id 1", config.getClientSecretCredentialsId());
61 | assertEquals("Private Key Cred is correct", "Private Key Credentials Id 1", config.getPrivateKeyCredentialsId());
62 |
63 | config = aioconfig.getProjectConfigs().get(1);
64 | assertEquals("Name is correct.", "Test Project 2", config.getName());
65 | assertEquals("API URL is correct.", "http://notdefault.adobe.io/url", config.getApiUrl());
66 | assertEquals("Client Id is correct", "Client Id 2", config.getClientId());
67 | assertEquals("IMS Org is correct", "Ims Organization Id 2", config.getImsOrganizationId());
68 | assertEquals("Tech Account is correct", "Technical Account Id 2", config.getTechnicalAccountId());
69 | assertEquals("Client Secret Cred is correct", "Client Secret Credentials Id 2", config.getClientSecretCredentialsId());
70 | assertEquals("Private Key Cred is correct", "Private Key Credentials Id 2", config.getPrivateKeyCredentialsId());
71 | }
72 |
73 | @Test
74 | @ConfiguredWithCode("configuration-as-code.yaml")
75 | public void exportConfiguration() throws Exception {
76 | AdobeIOConfig aioconfig = AdobeIOConfig.configuration();
77 | ConfiguratorRegistry registry = ConfiguratorRegistry.get();
78 | ConfigurationContext context = new ConfigurationContext(registry);
79 | Configurator configurator = context.lookupOrFail(AdobeIOConfig.class);
80 |
81 | CNode node = configurator.describe(aioconfig, context);
82 | assertNotNull(node);
83 | Mapping mapping = node.asMapping();
84 | CNode configsNode = mapping.get("projectConfigs");
85 |
86 | @SuppressWarnings("unchecked")
87 | List configs = (List) configsNode.asSequence();
88 | assertEquals(2, configs.size());
89 | assertEquals("Project Name is correct.", "Test Project 1", configs.get(0).getScalarValue("name"));
90 | assertEquals("Project Name is correct.", "Test Project 2", configs.get(1).getScalarValue("name"));
91 | }
92 |
93 | }
94 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/step/execution/PollPipelineExecution.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.step.execution;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.io.IOException;
30 | import java.util.concurrent.ScheduledFuture;
31 | import java.util.concurrent.TimeUnit;
32 |
33 | import hudson.AbortException;
34 | import hudson.Util;
35 | import hudson.model.TaskListener;
36 | import io.adobe.cloudmanager.CloudManagerApi;
37 | import io.adobe.cloudmanager.CloudManagerApiException;
38 | import io.jenkins.plugins.adobe.cloudmanager.CloudManagerPipelineExecution;
39 | import io.jenkins.plugins.adobe.cloudmanager.config.AdobeIOProjectConfig;
40 | import io.jenkins.plugins.adobe.cloudmanager.util.CloudManagerApiUtil;
41 | import jenkins.util.Timer;
42 | import org.jenkinsci.plugins.workflow.steps.StepContext;
43 |
44 | /**
45 | * Execution for a {@link io.jenkins.plugins.adobe.cloudmanager.step.PollPipelineStep}.
46 | * Periodically checks if the specified Cloud Manager execution is complete.
47 | */
48 | public class PollPipelineExecution extends AbstractStepExecution {
49 |
50 | private static final long serialVersionUID = 1L;
51 |
52 | private final long recurrencePeriod;
53 | private final boolean quiet;
54 | protected transient volatile ScheduledFuture task;
55 |
56 | public PollPipelineExecution(StepContext context, long recurrencePeriod, boolean quiet) {
57 | super(context);
58 | this.recurrencePeriod = recurrencePeriod;
59 | this.quiet = quiet;
60 | }
61 |
62 | @Override
63 | public void doStart() throws Exception {
64 | createTask();
65 | }
66 |
67 | @Override
68 | public void doResume() {
69 | createTask();
70 | }
71 |
72 | @Override
73 | public void doStop() throws Exception {
74 | if (task != null) {
75 | task.cancel(true);
76 | task = null;
77 | }
78 | }
79 |
80 | protected void createTask() {
81 | task = Timer.get().scheduleWithFixedDelay(() -> {
82 | try {
83 | AdobeIOProjectConfig aioProject = getAioProject();
84 | if (checkExecution(aioProject.getName())) {
85 | task.cancel(true);
86 | task = null;
87 | getContext().onSuccess(null);
88 | }
89 | } catch (IOException | InterruptedException e) {
90 | task.cancel(true);
91 | task = null;
92 | getContext().onFailure(e);
93 | }
94 | }, 0, recurrencePeriod, TimeUnit.MILLISECONDS);
95 | }
96 |
97 | private boolean checkExecution(String aioProjectName) throws AbortException {
98 | try {
99 | CloudManagerApi api = CloudManagerApiUtil.createApi().apply(aioProjectName).orElseThrow(() -> new AbortException(Messages.AbstractStepExecution_error_missingBuildData()));
100 | CloudManagerPipelineExecution execution = getBuildData().getCmExecution();
101 | if (api.isExecutionRunning(execution.getProgramId(), execution.getPipelineId(), execution.getExecutionId())) {
102 | if (!quiet) {
103 | getContext().get(TaskListener.class).getLogger().println(Messages.PollPipelineExecution_waiting(Util.getTimeSpanString(recurrencePeriod)));
104 | }
105 | return false;
106 | }
107 | getContext().get(TaskListener.class).getLogger().println(Messages.PollPipelineExecution_complete());
108 | } catch (AbortException e) {
109 | throw e;
110 | } catch (CloudManagerApiException e) {
111 | throw new AbortException(Messages.PollPipelineExecution_error_CloudManagerApiException(e.getLocalizedMessage()));
112 | } catch (Exception e) {
113 | throw new AbortException(e.getLocalizedMessage());
114 | }
115 | return true;
116 | }
117 |
118 | }
119 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/webhook/subscriber/PipelineStepEventSubscriber.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.webhook.subscriber;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.io.IOException;
30 | import java.util.Arrays;
31 | import java.util.HashSet;
32 | import java.util.Optional;
33 | import java.util.Set;
34 | import java.util.concurrent.TimeoutException;
35 | import javax.annotation.Nonnull;
36 |
37 | import hudson.Extension;
38 | import io.adobe.cloudmanager.CloudManagerApi;
39 | import io.adobe.cloudmanager.CloudManagerApiException;
40 | import io.adobe.cloudmanager.PipelineExecution;
41 | import io.adobe.cloudmanager.PipelineExecutionStepState;
42 | import io.adobe.cloudmanager.event.CloudManagerEvent;
43 | import io.adobe.cloudmanager.event.PipelineExecutionStepEndEvent;
44 | import io.adobe.cloudmanager.event.PipelineExecutionStepStartEvent;
45 | import io.adobe.cloudmanager.event.PipelineExecutionStepWaitingEvent;
46 | import io.jenkins.plugins.adobe.cloudmanager.step.execution.PipelineStepStateExecution;
47 | import io.jenkins.plugins.adobe.cloudmanager.util.CloudManagerApiUtil;
48 | import org.jenkinsci.plugins.workflow.steps.StepExecution;
49 | import org.slf4j.Logger;
50 | import org.slf4j.LoggerFactory;
51 | import static io.adobe.cloudmanager.event.CloudManagerEvent.EventType.*;
52 |
53 | /**
54 | * Subscriber for Cloud Manager pipeline execution step events.
55 | */
56 | @Extension
57 | public class PipelineStepEventSubscriber extends CloudManagerEventSubscriber {
58 | private static final Logger LOGGER = LoggerFactory.getLogger(PipelineStepEventSubscriber.class);
59 |
60 | private static final Set EVENTS = new HashSet<>(Arrays.asList(STEP_STARTED, STEP_WAITING, STEP_ENDED));
61 |
62 | @Nonnull
63 | @Override
64 | protected Set types() {
65 | return EVENTS;
66 | }
67 |
68 | /**
69 | * Calls all {@link io.jenkins.plugins.adobe.cloudmanager.step.PipelineStepStateStep} instances waiting for an event.
70 | */
71 | @Override
72 | protected void onEvent(final CloudManagerSubscriberEvent event) {
73 | Optional api = CloudManagerApiUtil.createApi().apply(event.getAioProjectName());
74 | if (!api.isPresent()) {
75 | LOGGER.error(Messages.CloudManagerEventSubscriber_error_createApi());
76 | return;
77 | }
78 | try {
79 |
80 | final PipelineExecutionStepState stepState;
81 | switch (event.getType()) {
82 | case STEP_STARTED:
83 | stepState = api.get().getExecutionStepState(CloudManagerEvent.parseEvent(event.getPayload(), PipelineExecutionStepStartEvent.class));
84 | break;
85 | case STEP_WAITING:
86 | stepState = api.get().getExecutionStepState(CloudManagerEvent.parseEvent(event.getPayload(), PipelineExecutionStepWaitingEvent.class));
87 | break;
88 | case STEP_ENDED:
89 | stepState = api.get().getExecutionStepState(CloudManagerEvent.parseEvent(event.getPayload(), PipelineExecutionStepEndEvent.class));
90 | break;
91 | default:
92 | LOGGER.warn(Messages.PipelineStepEventSubscriber_warn_invalidStepState(event.getType()));
93 | return;
94 | }
95 |
96 | final PipelineExecution pipelineExecution = stepState.getExecution();
97 | StepExecution.applyAll(PipelineStepStateExecution.class, (execution) -> {
98 | try {
99 | execution.process(pipelineExecution, stepState);
100 | } catch (IOException | InterruptedException | TimeoutException ex) {
101 | LOGGER.error(Messages.CloudManagerEventSubscriber_error_notifyExecution(ex.getLocalizedMessage()));
102 | }
103 | return null;
104 | });
105 | } catch (CloudManagerApiException e) {
106 | LOGGER.error(Messages.CloudManagerEventSubscriber_error_api(e.getLocalizedMessage()));
107 | }
108 | }
109 | }
110 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/util/CredentialsUtil.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.util;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.io.IOException;
30 | import java.nio.charset.Charset;
31 | import java.util.Collections;
32 | import java.util.Optional;
33 | import javax.annotation.Nonnull;
34 |
35 | import org.apache.commons.io.IOUtils;
36 | import org.apache.commons.lang.StringUtils;
37 |
38 | import com.cloudbees.plugins.credentials.Credentials;
39 | import com.cloudbees.plugins.credentials.CredentialsMatchers;
40 | import com.cloudbees.plugins.credentials.CredentialsProvider;
41 | import hudson.util.Secret;
42 | import io.jenkins.plugins.adobe.cloudmanager.config.AdobeIOProjectConfig;
43 | import jenkins.model.Jenkins;
44 | import org.jenkinsci.plugins.plaincredentials.FileCredentials;
45 | import org.jenkinsci.plugins.plaincredentials.StringCredentials;
46 | import org.slf4j.Logger;
47 | import org.slf4j.LoggerFactory;
48 |
49 | /**
50 | * Utility class for looking up Credentials for different forms.
51 | */
52 | public class CredentialsUtil {
53 |
54 | private static final Logger LOGGER = LoggerFactory.getLogger(CredentialsUtil.class);
55 | /**
56 | * Find the Client Secret for the specified credential id.
57 | *
58 | * @param credentialsId the id of the credentials
59 | * @return optional string containing the credentials
60 | */
61 | @Nonnull
62 | public static Optional clientSecretFor(String credentialsId) {
63 | return aioScopedCredentialsFor(credentialsId, StringCredentials.class).map(StringCredentials::getSecret);
64 | }
65 |
66 | /**
67 | * Find the Private Key for the specified credential id. This is returned as the String contents of the provided credential file.
68 | *
69 | * @param credentialsId the id of the credentials
70 | * @return optional String containing the credentials
71 | */
72 | @Nonnull
73 | public static Optional privateKeyFor(String credentialsId) {
74 | return aioScopedCredentialsFor(credentialsId, FileCredentials.class)
75 | .map(creds -> {
76 | try {
77 | return Secret.fromString(IOUtils.toString(creds.getContent(), Charset.defaultCharset()));
78 | } catch (IOException e) {
79 | LOGGER.error(Messages.CredentialsUtil_error_privateKeyError(credentialsId, e.getLocalizedMessage()));
80 | return null;
81 | }
82 | });
83 | }
84 |
85 | /**
86 | * Look up a Credential object from the stores, using the specified Id.
87 | *
88 | * @param credentialsId the id of the credential
89 | * @param type the type of the credential to lookup.
90 | * @param which type of credentials to lookup.
91 | * @return optional credential for the provided id
92 | */
93 | @Nonnull
94 | public static Optional credentialsFor(String credentialsId, Class type) {
95 | return CredentialsMatchers.filter(
96 | CredentialsProvider.lookupCredentials(type, Jenkins.get(), null, Collections.emptyList()),
97 | CredentialsMatchers.withId(StringUtils.trimToEmpty(credentialsId))
98 | ).stream().findFirst();
99 |
100 | }
101 |
102 | /**
103 | * Look up a Credential object from the stores, using the specified Id. Credentials are limited to the Adobe IO Domain.
104 | *
105 | * @param credentialsId the id of the credential
106 | * @param type the type of the credential to lookup.
107 | * @param which type of credentials to lookup.
108 | * @return optional credential for the provided id
109 | */
110 | @Nonnull
111 | public static Optional aioScopedCredentialsFor(String credentialsId, Class type) {
112 | return CredentialsMatchers.filter(
113 | CredentialsProvider.lookupCredentials(type, Jenkins.get(), null, AdobeIOProjectConfig.getAIODomainRequirement()),
114 | CredentialsMatchers.withId(StringUtils.trimToEmpty(credentialsId))
115 | ).stream().findFirst();
116 | }
117 | }
118 |
--------------------------------------------------------------------------------
/src/main/java/io/jenkins/plugins/adobe/cloudmanager/config/AdobeIOConfig.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.config;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.util.ArrayList;
30 | import java.util.Collections;
31 | import java.util.List;
32 | import javax.annotation.CheckForNull;
33 | import javax.annotation.Nonnull;
34 |
35 | import org.apache.commons.lang3.StringUtils;
36 |
37 | import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
38 | import hudson.Extension;
39 | import io.jenkins.plugins.adobe.cloudmanager.webhook.CloudManagerWebHook;
40 | import jenkins.model.GlobalConfiguration;
41 | import jenkins.model.Jenkins;
42 | import net.sf.json.JSONObject;
43 | import org.kohsuke.stapler.DataBoundSetter;
44 | import org.kohsuke.stapler.StaplerRequest;
45 |
46 | /**
47 | * Global Configuration panel for Adobe IO projects.
48 | */
49 | @Extension
50 | public class AdobeIOConfig extends GlobalConfiguration {
51 |
52 | // XML Config file name for storage.
53 | public static final String CLOUD_MANAGER_CONFIGURATION_ID = "adobe-cloud-manager-plugin-config";
54 |
55 | // Protect against no configurations done, and NPE.
56 | private static final AdobeIOConfig EMPTY_CONFIG = new AdobeIOConfig(Collections.emptyList());
57 |
58 | private List projectConfigs = new ArrayList<>();
59 |
60 | // Webhook is disabled by default - make a conscious decision to enable it.
61 | private boolean webhookEnabled = false;
62 |
63 | @SuppressFBWarnings("MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR")
64 | public AdobeIOConfig() {
65 | getConfigFile().getXStream().alias("adobe-io-project-config", AdobeIOProjectConfig.class);
66 | load();
67 | }
68 |
69 | public AdobeIOConfig(@Nonnull List projectConfigs) {
70 | this.projectConfigs = projectConfigs;
71 | }
72 |
73 | /**
74 | * Helper for looking up this configuration, protecting against null.
75 | */
76 | @Nonnull
77 | public static AdobeIOConfig configuration() {
78 | AdobeIOConfig config = AdobeIOConfig.all().get(AdobeIOConfig.class);
79 | if (config == null) {
80 | config = EMPTY_CONFIG;
81 | }
82 | return config;
83 | }
84 |
85 | /**
86 | * Helper to find an AIO Project config based on a name.
87 | *
88 | * Name must match exactly.
89 | *
90 | *
91 | * Useful for checking after restarts or for long running builds.
92 | *
93 | *
94 | * @param name the name of the AIO Project Config
95 | * @return config or null
96 | */
97 | @CheckForNull
98 | public static AdobeIOProjectConfig projectConfigFor(@Nonnull String name) {
99 | return AdobeIOConfig.configuration().getProjectConfigs()
100 | .stream()
101 | .filter(c -> StringUtils.equals(name, c.getName()))
102 | .findFirst().orElse(null);
103 | }
104 |
105 | @Nonnull
106 | public List getProjectConfigs() {
107 | return Collections.unmodifiableList(projectConfigs);
108 | }
109 |
110 | @DataBoundSetter
111 | public void setProjectConfigs(@Nonnull List projectConfigs) {
112 | this.projectConfigs = projectConfigs;
113 | }
114 |
115 | public boolean isWebhookEnabled() {
116 | return webhookEnabled;
117 | }
118 |
119 | @DataBoundSetter
120 | public void setWebhookEnabled(boolean webhookEnabled) {
121 | this.webhookEnabled = webhookEnabled;
122 | }
123 |
124 | public String getWebhookUrl() {
125 | return String.format("%s/%s/", Jenkins.get().getRootUrl(), CloudManagerWebHook.URL_NAME);
126 | }
127 |
128 | /**
129 | * To avoid long class name as id in xml tag name and config file
130 | */
131 | @Override
132 | public String getId() {
133 | return CLOUD_MANAGER_CONFIGURATION_ID;
134 | }
135 |
136 | @Override
137 | public String getDisplayName() {
138 | return "Adobe IO";
139 | }
140 |
141 | @Override
142 | public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
143 | projectConfigs = new ArrayList<>(); // Form binding does not save empty lists properly.
144 | super.configure(req, json);
145 | save();
146 | return true;
147 | }
148 | }
149 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/adobe/cloudmanager/builder/CloudManagerBuilderTest.java:
--------------------------------------------------------------------------------
1 | package io.jenkins.plugins.adobe.cloudmanager.builder;
2 |
3 | /*-
4 | * #%L
5 | * Adobe Cloud Manager Plugin
6 | * %%
7 | * Copyright (C) 2020 - 2021 Adobe Inc.
8 | * %%
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy
10 | * of this software and associated documentation files (the "Software"), to deal
11 | * in the Software without restriction, including without limitation the rights
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | * copies of the Software, and to permit persons to whom the Software is
14 | * furnished to do so, subject to the following conditions:
15 | *
16 | * The above copyright notice and this permission notice shall be included in
17 | * all copies or substantial portions of the Software.
18 | *
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 | * THE SOFTWARE.
26 | * #L%
27 | */
28 |
29 | import java.util.Optional;
30 | import java.util.function.Function;
31 |
32 | import hudson.AbortException;
33 | import io.adobe.cloudmanager.CloudManagerApi;
34 | import io.jenkins.plugins.adobe.cloudmanager.util.CloudManagerApiUtil;
35 | import mockit.Injectable;
36 | import mockit.Mock;
37 | import mockit.MockUp;
38 | import mockit.Mocked;
39 | import mockit.Tested;
40 | import org.junit.Before;
41 | import org.junit.Test;
42 | import static io.jenkins.plugins.adobe.cloudmanager.test.TestHelper.*;
43 | import static org.junit.Assert.*;
44 |
45 | public class CloudManagerBuilderTest {
46 |
47 | private static final String PROGRAM_ID = "2";
48 | private static final String PIPELINE_ID = "4";
49 |
50 | @Injectable
51 | private final String aioProject = AIO_PROJECT_NAME;
52 | @Injectable
53 | private final String program = "Program Name";
54 | @Injectable
55 | private final String pipeline = "Pipeline Name";
56 | @Tested
57 | private CloudManagerBuilder builder;
58 | @Mocked
59 | private CloudManagerApi api;
60 |
61 |
62 | @Before
63 | public void before() {
64 | new MockUp() {
65 | @Mock
66 | public Function> createApi() { return (name) -> Optional.of(api); }
67 | };
68 | }
69 |
70 | @Test
71 | public void createApi() throws Exception {
72 | assertNotNull(builder.createApi());
73 | }
74 |
75 | @Test
76 | public void createApiFailed() throws Exception {
77 | new MockUp() {
78 | @Mock
79 | public Function> createApi() { return (name) -> Optional.empty(); }
80 | };
81 |
82 | assertThrows(AbortException.class, () -> builder.createApi());
83 | }
84 |
85 | @Test
86 | public void missingProgram() throws Exception {
87 | new MockUp() {
88 | @Mock
89 | public Optional getProgramId(final CloudManagerApi api, final String programName) throws AbortException {
90 | return Optional.empty();
91 | }
92 | };
93 | AbortException exception = assertThrows(AbortException.class, () -> builder.getProgramId(api));
94 | assertEquals(Messages.CloudManagerBuilder_error_missingProgram(program), exception.getLocalizedMessage());
95 | }
96 |
97 |
98 | @Test
99 | public void getProgramIdFromName() throws Exception {
100 | new MockUp() {
101 | @Mock
102 | public Optional getProgramId(final CloudManagerApi api, final String programName) throws AbortException {
103 | return Optional.of(PROGRAM_ID);
104 | }
105 | };
106 |
107 | assertEquals(PROGRAM_ID, builder.getProgramId(api));
108 | }
109 |
110 | @Test
111 | public void getProgramIdFromId(@Tested CloudManagerBuilder localBuilder) throws Exception {
112 | localBuilder.setProgram(PROGRAM_ID);
113 | assertEquals(PROGRAM_ID, localBuilder.getProgramId(api));
114 | }
115 |
116 | @Test
117 | public void missingPipeline() throws Exception {
118 | new MockUp() {
119 | @Mock
120 | public Optional getPipelineId(final CloudManagerApi api, final String programId, final String pipelineName) throws AbortException {
121 | return Optional.empty();
122 | }
123 | };
124 |
125 | AbortException exception = assertThrows(AbortException.class, () -> builder.getPipelineId(api, PROGRAM_ID));
126 | assertEquals(Messages.CloudManagerBuilder_error_missingPipeline(pipeline), exception.getLocalizedMessage());
127 | }
128 |
129 | @Test
130 | public void getPipelineIdFromName() throws Exception {
131 | new MockUp() {
132 | @Mock
133 | public Optional getPipelineId(final CloudManagerApi api, final String programId, final String pipelineName) throws AbortException {
134 | return Optional.of(PIPELINE_ID);
135 | }
136 | };
137 |
138 | assertEquals(PIPELINE_ID, builder.getPipelineId(api, PROGRAM_ID));
139 | }
140 |
141 | @Test
142 | public void getPipelineIdFromId(@Tested CloudManagerBuilder localBuilder) throws Exception {
143 | localBuilder.setPipeline(PIPELINE_ID);
144 | assertEquals(PIPELINE_ID, localBuilder.getPipelineId(api, PROGRAM_ID));
145 | }
146 |
147 | }
148 |
--------------------------------------------------------------------------------
12 | 
12 | 
16 | 
17 | 
32 | 
12 | 
22 |