input-parameters.ts

import { getBooleanInput, getInput, getMultilineInput } from '@actions/core'

const EnvironmentVariables = {
  URL: 'OCTOPUS_URL',
  ApiKey: 'OCTOPUS_API_KEY',
  AccessToken: 'OCTOPUS_ACCESS_TOKEN',
  Space: 'OCTOPUS_SPACE'
} as const

export interface InputParameters {
  // Optional: A server is required, but you should use the OCTOPUS_URL env
  server: string
  // Optional: An API key is required, but you should use the OCTOPUS_API_KEY environment variable instead of this.
  apiKey?: string
  // Optional: Access token can only be obtained from the OCTOPUS_ACCESS_TOKEN environment variable.
  accessToken?: string
  // Optional: You should prefer the OCTOPUS_SPACE environment variable
  space: string
  // Required
  serverTaskId: string

  // Optional
  pollingInterval: number
  timeout: number
  hideProgress: boolean
}

export function getInputParameters(): InputParameters {
  let variablesMap: Map<string, string> | undefined = undefined
  const variables = getMultilineInput('variables').map(p => p.trim()) || undefined
  if (variables) {
    variablesMap = new Map()
    for (const variable of variables) {
      const variableMap = variable.split(':').map(x => x.trim())
      variablesMap?.set(variableMap[0], variableMap[1])
    }
  }

  let pollingInterval = 10
  const intervalInput = getInput('polling_interval')
  if (intervalInput) {
    pollingInterval = parseInt(intervalInput)
  }

  let timeout = 600
  const timeoutInput = getInput('timeout')
  if (timeoutInput) {
    timeout = parseInt(timeoutInput)
  }

  const parameters: InputParameters = {
    server: getInput('server') || process.env[EnvironmentVariables.URL] || '',
    apiKey: getInput('api_key') || process.env[EnvironmentVariables.ApiKey],
    accessToken: process.env[EnvironmentVariables.AccessToken],
    space: getInput('space') || process.env[EnvironmentVariables.Space] || '',
    serverTaskId: getInput('server_task_id', { required: true }),
    pollingInterval,
    timeout,
    hideProgress: getBooleanInput('hide_progress') || false
  }

  const errors: string[] = []
  if (!parameters.server) {
    errors.push(
      "The Octopus instance URL is required, please specify explicitly through the 'server' input or set the OCTOPUS_URL environment variable."
    )
  }

  if (!parameters.apiKey && !parameters.accessToken) {
    errors.push(
      "The Octopus API Key is required, please specify explicitly through the 'api_key' input or set the OCTOPUS_API_KEY environment variable."
    )
  }

  if (!parameters.space) {
    errors.push(
      "The Octopus space name is required, please specify explicitly through the 'space' input or set the OCTOPUS_SPACE environment variable."
    )
  }

  if (errors.length > 0) {
    throw new Error(errors.join('\n'))
  }

  return parameters
}