com.liferay.source.formatter.util.JIRAUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.liferay.source.formatter

Liferay Source Formatter

There is a newer version: 1.0.1457

/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.source.formatter.util;

import com.liferay.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.util.StringUtil;

import java.util.List;

/**
 * @author Hugo Huijser
 */
public class JIRAUtil {

	public static void validateJIRAProjectNames(
			List commitMessages, List projectNames)
		throws Exception {

		if (projectNames.isEmpty()) {
			return;
		}

		outerLoop:
		for (String commitMessage : commitMessages) {
			String[] parts = commitMessage.split(":", 2);

			String commitMessageTitle = parts[1];

			if (Character.isWhitespace(commitMessageTitle.charAt(0))) {
				throw new Exception(
					StringBundler.concat(
						"Found formatting issue in SHA ", parts[0], "\n",
						"The commit message should not start with whitespace"));
			}

			int x = parts[1].indexOf("\n");

			if (x != -1) {
				commitMessageTitle = commitMessageTitle.substring(0, x);
			}

			if (commitMessageTitle.startsWith("Reapply ") ||
				commitMessageTitle.startsWith("Revert ") ||
				commitMessageTitle.startsWith("artifact:ignore") ||
				commitMessageTitle.startsWith("build.gradle auto SF") ||
				commitMessageTitle.endsWith("/ci-merge.")) {

				continue;
			}

			for (String projectName : projectNames) {
				if (commitMessageTitle.startsWith(projectName)) {
					continue outerLoop;
				}
			}

			throw new Exception(
				StringBundler.concat(
					"Found formatting issue in SHA ", parts[0], "\n",
					"The commit message is missing a reference to a required ",
					"JIRA project: ",
					StringUtil.merge(projectNames, StringPool.COMMA_AND_SPACE),
					". Please verify that the JIRA project keys are specified",
					"in source-formatter.properties in the liferay-portal ",
					"repository."));
		}
	}

}