Merge branch 'main' into dependabot/npm_and_yarn/actions-7d07fb3801

Author: Tatsinnit

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [5.0.3] - 2025-04-16
+
+### Added
+
+- #398 case-insensitive resource type
+
+## [5.0.2] - 2025-04-15
+
+### Added
+
+- #396 Update new resource-type input for action
+
 ## [5.0.1] - 2024-03-12
 
 ### Added

src/actions/deploy.ts

@@ -13,17 +13,15 @@ import {
 } from '../strategyHelpers/deploymentHelper'
 import {DeploymentStrategy} from '../types/deploymentStrategy'
 import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
+import {ClusterType} from '../inputUtils'
 export const ResourceTypeManagedCluster =
    'Microsoft.ContainerService/managedClusters'
 export const ResourceTypeFleet = 'Microsoft.ContainerService/fleets'
-export type ClusterType =
-   | typeof ResourceTypeManagedCluster
-   | typeof ResourceTypeFleet
-
 export async function deploy(
    kubectl: Kubectl,
    manifestFilePaths: string[],
-   deploymentStrategy: DeploymentStrategy
+   deploymentStrategy: DeploymentStrategy,
+   resourceType: ClusterType
 ) {
    // update manifests
    const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths)
@@ -45,25 +43,14 @@ export async function deploy(
 
    // check manifest stability
    core.startGroup('Checking manifest stability')
-   const resourceTypeInput =
-      core.getInput('resource-type') || ResourceTypeManagedCluster
    const resourceTypes: Resource[] = getResources(
       deployedManifestFiles,
       models.DEPLOYMENT_TYPES.concat([
          KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
       ])
    )
 
-   if (
-      resourceTypeInput !== ResourceTypeManagedCluster &&
-      resourceTypeInput !== ResourceTypeFleet
-   ) {
-      let errMsg = `Invalid resource type: ${resourceTypeInput}. Supported resource types are: ${ResourceTypeManagedCluster} (default), ${ResourceTypeFleet}`
-      core.setFailed(errMsg)
-      throw new Error(errMsg)
-   }
-
-   await checkManifestStability(kubectl, resourceTypes, resourceTypeInput)
+   await checkManifestStability(kubectl, resourceTypes, resourceType)
    core.endGroup()
 
    // print ingresses

src/actions/promote.ts

@@ -38,19 +38,20 @@ import {
    TrafficSplitMethod
 } from '../types/trafficSplitMethod'
 import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
-import {ResourceTypeFleet, ResourceTypeManagedCluster} from './deploy'
+import {ClusterType} from '../inputUtils'
 
 export async function promote(
    kubectl: Kubectl,
    manifests: string[],
-   deploymentStrategy: DeploymentStrategy
+   deploymentStrategy: DeploymentStrategy,
+   resourceType: ClusterType
 ) {
    switch (deploymentStrategy) {
       case DeploymentStrategy.CANARY:
          await promoteCanary(kubectl, manifests)
          break
       case DeploymentStrategy.BLUE_GREEN:
-         await promoteBlueGreen(kubectl, manifests)
+         await promoteBlueGreen(kubectl, manifests, resourceType)
          break
       default:
          throw Error('Invalid promote deployment strategy')
@@ -140,7 +141,11 @@ async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
    core.endGroup()
 }
 
-async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
+async function promoteBlueGreen(
+   kubectl: Kubectl,
+   manifests: string[],
+   resourceType: ClusterType
+) {
    // update container images and pull secrets
    const inputManifestFiles: string[] = updateManifestFiles(manifests)
    const manifestObjects: BlueGreenManifests =
@@ -167,23 +172,13 @@ async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
 
    // checking stability of newly created deployments
    core.startGroup('Checking manifest stability')
-   const resourceType =
-      core.getInput('resource-type') || ResourceTypeManagedCluster
    const deployedManifestFiles = deployResult.manifestFiles
    const resources: Resource[] = getResources(
       deployedManifestFiles,
       models.DEPLOYMENT_TYPES.concat([
          models.DiscoveryAndLoadBalancerResource.SERVICE
       ])
    )
-   if (
-      resourceType !== ResourceTypeManagedCluster &&
-      resourceType !== ResourceTypeFleet
-   ) {
-      const errMsg = `Invalid resource type: ${resourceType}. Supported resource types are: ${ResourceTypeManagedCluster} (default), fleet`
-      core.setFailed(errMsg)
-      throw new Error(errMsg)
-   }
    await KubernetesManifestUtility.checkManifestStability(
       kubectl,
       resources,

src/inputUtils.test.ts

@@ -0,0 +1,34 @@
+import {parseResourceTypeInput} from './inputUtils'
+import {
+   ClusterType,
+   ResourceTypeFleet,
+   ResourceTypeManagedCluster
+} from './actions/deploy'
+
+describe('InputUtils', () => {
+   describe('parseResourceTypeInput', () => {
+      it('should extract fleet exact match resource type', () => {
+         expect(
+            parseResourceTypeInput('Microsoft.ContainerService/fleets')
+         ).toEqual(ResourceTypeFleet)
+      })
+      it('should match fleet case-insensitively', () => {
+         expect(
+            parseResourceTypeInput('Microsoft.containerservice/fleets')
+         ).toEqual(ResourceTypeFleet)
+      })
+      it('should match managed cluster case-insensitively', () => {
+         expect(
+            parseResourceTypeInput('Microsoft.containerservice/MAnaGedClusterS')
+         ).toEqual(ResourceTypeManagedCluster)
+      })
+      it('should error on unexpected values', () => {
+         expect(() => {
+            parseResourceTypeInput('icrosoft.ContainerService/ManagedCluster')
+         }).toThrow()
+         expect(() => {
+            parseResourceTypeInput('wrong-value')
+         }).toThrow()
+      })
+   })
+})

src/inputUtils.ts

@@ -1,5 +1,6 @@
 import * as core from '@actions/core'
 import {parseAnnotations} from './types/annotations'
+import {ResourceTypeFleet, ResourceTypeManagedCluster} from './actions/deploy'
 
 export const inputAnnotations = parseAnnotations(
    core.getInput('annotations', {required: false})
@@ -14,3 +15,18 @@ export function getBufferTime(): number {
 
    return inputBufferTime
 }
+
+export function parseResourceTypeInput(rawInput: string): ClusterType {
+   switch (rawInput.toLowerCase()) {
+      case ResourceTypeFleet.toLowerCase():
+         return ResourceTypeFleet
+      case ResourceTypeManagedCluster.toLowerCase():
+         return ResourceTypeManagedCluster
+   }
+   throw new Error(
+      `Invalid resource type: ${rawInput}. Supported resource types are: ${ResourceTypeManagedCluster} (default), ${ResourceTypeFleet}`
+   )
+}
+export type ClusterType =
+   | typeof ResourceTypeManagedCluster
+   | typeof ResourceTypeFleet

src/run.ts

@@ -1,12 +1,18 @@
 import * as core from '@actions/core'
 import {getKubectlPath, Kubectl} from './types/kubectl'
-import {deploy} from './actions/deploy'
+import {
+   deploy,
+   ResourceTypeFleet,
+   ResourceTypeManagedCluster
+} from './actions/deploy'
+import {ClusterType} from './inputUtils'
 import {promote} from './actions/promote'
 import {reject} from './actions/reject'
 import {Action, parseAction} from './types/action'
 import {parseDeploymentStrategy} from './types/deploymentStrategy'
 import {getFilesFromDirectoriesAndURLs} from './utilities/fileUtils'
 import {PrivateKubectl} from './types/privatekubectl'
+import {parseResourceTypeInput} from './inputUtils'
 
 export async function run() {
    // verify kubeconfig is set
@@ -36,6 +42,16 @@ export async function run() {
    const resourceName = core.getInput('name') || ''
    const skipTlsVerify = core.getBooleanInput('skip-tls-verify')
 
+   let resourceType: ClusterType
+   try {
+      // included in the trycatch to allow raw input to go out of scope after parsing
+      const resourceTypeInput = core.getInput('resource-type')
+      resourceType = parseResourceTypeInput(resourceTypeInput)
+   } catch (e) {
+      core.setFailed(e)
+      return
+   }
+
    const kubectl = isPrivateCluster
       ? new PrivateKubectl(
            kubectlPath,
@@ -49,11 +65,11 @@ export async function run() {
    // run action
    switch (action) {
       case Action.DEPLOY: {
-         await deploy(kubectl, fullManifestFilePaths, strategy)
+         await deploy(kubectl, fullManifestFilePaths, strategy, resourceType)
          break
       }
       case Action.PROMOTE: {
-         await promote(kubectl, fullManifestFilePaths, strategy)
+         await promote(kubectl, fullManifestFilePaths, strategy, resourceType)
          break
       }
       case Action.REJECT: {

src/strategyHelpers/deploymentHelper.ts

@@ -35,7 +35,7 @@ import {
 } from '../utilities/githubUtils'
 import {getDeploymentConfig} from '../utilities/dockerUtils'
 import {DeployResult} from '../types/deployResult'
-import {ClusterType} from '../actions/deploy'
+import {ClusterType} from '../inputUtils'
 
 export async function deployManifests(
    files: string[],

src/utilities/manifestStabilityUtils.ts

@@ -3,18 +3,19 @@ import * as KubernetesConstants from '../types/kubernetesTypes'
 import {Kubectl, Resource} from '../types/kubectl'
 import {checkForErrors} from './kubectlUtils'
 import {sleep} from './timeUtils'
-import {ClusterType, ResourceTypeFleet} from '../actions/deploy'
+import {ResourceTypeFleet} from '../actions/deploy'
+import {ClusterType} from '../inputUtils'
 
 const IS_SILENT = false
 const POD = 'pod'
 
 export async function checkManifestStability(
    kubectl: Kubectl,
    resources: Resource[],
-   clusterTyper: ClusterType
+   resourceType: ClusterType
 ): Promise<void> {
    // Skip if resource type is microsoft.containerservice/fleets
-   if (clusterTyper === ResourceTypeFleet) {
+   if (resourceType === ResourceTypeFleet) {
       core.info(`Skipping checkManifestStability for ${ResourceTypeFleet}`)
       return
    }