import * as path from 'path'; import * as core from '@actions/core'; import * as io from '@actions/io'; import * as fs from 'fs'; import * as os from 'os'; import * as constants from './constants.js'; import * as gpg from './gpg.js'; import {getBooleanInput} from './util.js'; import {escapeXmlText} from './xml.js'; export interface MavenServerCredentials { id: string; usernameEnvVar: string; passwordEnvVar: string; } export interface MavenRepository { id: string; url: string; snapshotsEnabled: boolean; releasesEnabled?: boolean; } export interface MavenRepositorySettings { repositories: MavenRepository[]; includeCentral: boolean; prioritizeCentral: boolean; } export async function configureAuthentication() { const servers = getMavenServerSettings(); const repositorySettings = getMavenRepositorySettings(); const settingsDirectory = core.getInput(constants.INPUT_SETTINGS_PATH) || path.join(os.homedir(), constants.M2_DIR); const overwriteSettings = getBooleanInput( constants.INPUT_OVERWRITE_SETTINGS, true ); const gpgPrivateKey = core.getInput(constants.INPUT_GPG_PRIVATE_KEY) || constants.INPUT_DEFAULT_GPG_PRIVATE_KEY; const gpgPassphraseEnvVar = getInputWithDeprecatedAlias( constants.INPUT_GPG_PASSPHRASE_ENV_VAR, constants.INPUT_GPG_PASSPHRASE_DEPRECATED, gpgPrivateKey ? constants.INPUT_DEFAULT_GPG_PASSPHRASE : undefined ); if (gpgPrivateKey) { core.setSecret(gpgPrivateKey); } await createAuthenticationSettings( servers, settingsDirectory, overwriteSettings, gpgPassphraseEnvVar, repositorySettings ); if (gpgPrivateKey) { core.info('Importing private gpg key'); const gpgHome = await gpg.importKey(gpgPrivateKey); try { core.saveState(constants.STATE_GPG_HOME, gpgHome); core.exportVariable('GNUPGHOME', gpg.toGpgPath(gpgHome)); } catch (error) { await gpg.removeGpgHome(gpgHome); throw error; } } } export function getInputWithDeprecatedAlias( inputName: string, deprecatedInputName: string, defaultValue?: string ): string { const value = core.getInput(inputName); const deprecatedValue = core.getInput(deprecatedInputName); if (deprecatedValue) { core.warning( `The '${deprecatedInputName}' input is deprecated and may be removed in a future release. Please use '${inputName}' instead.` ); } return value || deprecatedValue || defaultValue || ''; } // only exported for testing purposes export function getMavenServerSettings(): MavenServerCredentials[] { const entries = core.getMultilineInput( constants.INPUT_MVN_SERVER_CREDENTIALS ); if (entries.some(entry => entry.trim())) { return parseMavenServerCredentials(entries); } return [ { id: core.getInput(constants.INPUT_SERVER_ID), usernameEnvVar: getInputWithDeprecatedAlias( constants.INPUT_SERVER_USERNAME_ENV_VAR, constants.INPUT_SERVER_USERNAME_DEPRECATED, constants.INPUT_DEFAULT_SERVER_USERNAME ), passwordEnvVar: getInputWithDeprecatedAlias( constants.INPUT_SERVER_PASSWORD_ENV_VAR, constants.INPUT_SERVER_PASSWORD_DEPRECATED, constants.INPUT_DEFAULT_SERVER_PASSWORD ) } ]; } // only exported for testing purposes export function parseMavenServerCredentials( entries: string[] ): MavenServerCredentials[] { const servers: MavenServerCredentials[] = []; const serverIds = new Set(); entries.forEach((entry, index) => { if (!entry.trim()) { return; } const fields = entry.split(':'); if (fields.length !== 3) { throw new Error( `Invalid mvn-server-credentials entry at line ${index + 1}. Expected format: server-id:USERNAME_ENV:PASSWORD_ENV` ); } const [id, usernameEnvVar, passwordEnvVar] = fields.map(field => field.trim() ); if (!id || !usernameEnvVar || !passwordEnvVar) { throw new Error( `Invalid mvn-server-credentials entry at line ${index + 1}. server-id, username environment variable, and password environment variable are required` ); } if (serverIds.has(id)) { throw new Error( `Duplicate server-id '${id}' in mvn-server-credentials input` ); } serverIds.add(id); servers.push({id, usernameEnvVar, passwordEnvVar}); }); return servers; } // only exported for testing purposes export function getMavenRepositorySettings(): MavenRepositorySettings | undefined { const entries = core.getMultilineInput(constants.INPUT_MVN_REPOSITORIES); if (!entries.some(entry => entry.trim())) { return undefined; } const includeCentral = getBooleanInput( constants.INPUT_MVN_REPOSITORIES_INCLUDE_CENTRAL, true ); return { repositories: parseMavenRepositories(entries, includeCentral), includeCentral, prioritizeCentral: getBooleanInput( constants.INPUT_MVN_REPOSITORIES_PRIORITIZE_CENTRAL, true ) }; } // only exported for testing purposes export function parseMavenRepositories( entries: string[], includeCentral: boolean ): MavenRepository[] { const repositories: MavenRepository[] = []; const repositoryIds = new Set(); entries.forEach((entry, index) => { if (!entry.trim()) { return; } const firstSeparator = entry.indexOf(':'); const lastSeparator = entry.lastIndexOf(':'); if (firstSeparator <= 0 || lastSeparator <= firstSeparator) { throw new Error( `Invalid mvn-repositories entry at line ${index + 1}. Expected format: repository-id:repository-url:snapshots-enabled` ); } const id = entry.slice(0, firstSeparator).trim(); const url = entry.slice(firstSeparator + 1, lastSeparator).trim(); const snapshotsValue = entry .slice(lastSeparator + 1) .trim() .toLowerCase(); if (!id || !url || !snapshotsValue) { throw new Error( `Invalid mvn-repositories entry at line ${index + 1}. repository-id, repository URL, and snapshots-enabled are required` ); } if (snapshotsValue !== 'true' && snapshotsValue !== 'false') { throw new Error( `Invalid snapshots-enabled value '${snapshotsValue}' in mvn-repositories entry at line ${index + 1}. Expected true or false` ); } if (repositoryIds.has(id)) { throw new Error( `Duplicate repository-id '${id}' in mvn-repositories input` ); } if (includeCentral && id === constants.MAVEN_CENTRAL_REPOSITORY_ID) { throw new Error( `Repository-id '${constants.MAVEN_CENTRAL_REPOSITORY_ID}' is reserved when ${constants.INPUT_MVN_REPOSITORIES_INCLUDE_CENTRAL} is enabled` ); } repositoryIds.add(id); repositories.push({ id, url, snapshotsEnabled: snapshotsValue === 'true' }); }); return repositories; } export async function createAuthenticationSettings( servers: MavenServerCredentials[], settingsDirectory: string, overwriteSettings: boolean, gpgPassphraseEnvVar: string | undefined = undefined, repositorySettings: MavenRepositorySettings | undefined = undefined ) { core.info( `Creating ${constants.MVN_SETTINGS_FILE} with server-id: ${servers.map(server => server.id).join(', ')}` ); // when an alternate m2 location is specified use only that location (no .m2 directory) // otherwise use the home/.m2/ path await io.mkdirP(settingsDirectory); await write( settingsDirectory, generate(servers, gpgPassphraseEnvVar, repositorySettings), overwriteSettings ); } // only exported for testing purposes export function generate( servers: MavenServerCredentials[], gpgPassphraseEnvVar?: string | undefined, repositorySettings?: MavenRepositorySettings | undefined ) { // The maven-gpg-plugin reads the passphrase from the environment variable // named by the `gpg.passphraseEnvName` property (default MAVEN_GPG_PASSPHRASE). // Only configure it when the requested env var name differs from that default; // otherwise the plugin already reads the right variable and no extra settings // are needed. Writing `gpg.passphrase` to settings.xml is deprecated and fails // when the plugin's `bestPractices` mode is enabled. const includeGpgPassphraseProfile = gpgPassphraseEnvVar && gpgPassphraseEnvVar !== constants.MAVEN_GPG_PASSPHRASE_DEFAULT_ENV; const lines = [ '', ' false', ' ' ]; for (const server of servers) { lines.push( ' ', ` ${escapeXmlText(server.id)}`, ` ${escapeXmlText(`\${env.${server.usernameEnvVar}}`)}`, ` ${escapeXmlText(`\${env.${server.passwordEnvVar}}`)}`, ' ' ); } lines.push(' '); if (repositorySettings || includeGpgPassphraseProfile) { lines.push(' '); if (repositorySettings) { const centralRepository: MavenRepository = { id: constants.MAVEN_CENTRAL_REPOSITORY_ID, url: constants.MAVEN_CENTRAL_REPOSITORY_URL, snapshotsEnabled: false }; const customCentralConfigured = repositorySettings.repositories.some( repository => repository.id === constants.MAVEN_CENTRAL_REPOSITORY_ID ); const repositories = repositorySettings.includeCentral ? repositorySettings.prioritizeCentral ? [centralRepository, ...repositorySettings.repositories] : [...repositorySettings.repositories, centralRepository] : customCentralConfigured ? repositorySettings.repositories : [ ...repositorySettings.repositories, {...centralRepository, releasesEnabled: false} ]; lines.push( ' ', ` ${constants.MAVEN_REPOSITORIES_PROFILE_ID}`, ' ' ); for (const repository of repositories) { lines.push( ' ', ` ${escapeXmlText(repository.id)}`, ` ${escapeXmlText(repository.url)}`, ...(repository.releasesEnabled === undefined ? [] : [ ' ', ` ${repository.releasesEnabled}`, ' ' ]), ' ', ` ${repository.snapshotsEnabled}`, ' ', ' ' ); } lines.push(' ', ' '); } if (includeGpgPassphraseProfile) { lines.push( ' ', ` ${constants.GPG_PASSPHRASE_PROFILE_ID}`, ' ', ` ${escapeXmlText(gpgPassphraseEnvVar)}`, ' ', ' ' ); } lines.push(' ', ' '); if (repositorySettings) { lines.push( ` ${constants.MAVEN_REPOSITORIES_PROFILE_ID}` ); } if (includeGpgPassphraseProfile) { lines.push( ` ${constants.GPG_PASSPHRASE_PROFILE_ID}` ); } lines.push(' '); } lines.push(''); return lines.join('\n'); } async function write( directory: string, settings: string, overwriteSettings: boolean ) { const location = path.join(directory, constants.MVN_SETTINGS_FILE); const settingsExists = fs.existsSync(location); if (settingsExists && overwriteSettings) { core.info(`Overwriting existing file ${location}`); } else if (!settingsExists) { core.info(`Writing to ${location}`); } else { core.info( `Skipping generation ${location} because file already exists and overwriting is not required` ); return; } return fs.writeFileSync(location, settings, { encoding: 'utf-8', flag: 'w' }); }