org.marvelution.test.jenkins.scm.IssueCommitMockingSCM Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
Test utils specific for the JJI project
The newest version!
/*
 * Copyright (c) 2012-present Marvelution B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.marvelution.test.jenkins.scm;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;

import hudson.Extension;
import hudson.FilePath;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.BuildListener;
import hudson.scm.ChangeLogParser;
import hudson.scm.NullSCM;
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
import net.sf.json.JSONObject;
import org.kohsuke.stapler.StaplerRequest;

/**
 * Test {@link SCM} implementation that generates a list of commits that have a JIRA issue key in the message
 *
 * @author Mark Rekveld
 * @since 1.6.0
 */
public class IssueCommitMockingSCM extends NullSCM {

	private final String projectKey;
	private final int issueCount;

	public IssueCommitMockingSCM(String projectKey, int issueCount) {
		this.projectKey = projectKey;
		this.issueCount = issueCount;
	}

	@Override
	public boolean checkout(AbstractBuild build, Launcher launcher, FilePath workspace, BuildListener listener, File changeLogFile)
			throws IOException, InterruptedException {
		if (workspace.exists()) {
			listener.getLogger().println("Deleting existing workspace " + workspace.getRemote());
			workspace.deleteRecursive();
		}
		try (PrintStream stream = new PrintStream(new FileOutputStream(changeLogFile), false, "UTF-8")) {
			stream.println("");
			stream.println("");
			for (int i = 0; i < issueCount; i++) {
				stream.println("");
				stream.println("" + projectKey + "-" + (i + build.getNumber()) + ", commit with an issue key");
				stream.println("mark");
				stream.println("");
			}
			stream.println("");
			stream.close();
		}
		return true;
	}

	@Override
	public ChangeLogParser createChangeLogParser() {
		return new SimpleChangelogParser();
	}

	@Extension
	public static class DescriptorImpl extends SCMDescriptor {

		public DescriptorImpl() {
			super(null);
		}

		public String getDisplayName() {
			return "Issue Mocking SCM";
		}

		@Override
		public SCM newInstance(StaplerRequest req, JSONObject formData) throws FormException {
			return new IssueCommitMockingSCM("YOP", 5);
		}
	}

}