chore: naming for the types for Argo Rollouts

Author: ivanstanev

src/supervisor/watchers/handlers/argo-rollout.ts

@@ -1,7 +1,11 @@
 import { IncomingMessage } from 'http';
 import { deleteWorkload } from './workload';
 import { WorkloadKind } from '../../types';
-import { FALSY_WORKLOAD_NAME_MARKER, Rollout, RolloutList } from './types';
+import {
+  FALSY_WORKLOAD_NAME_MARKER,
+  V1alpha1Rollout,
+  V1alpha1RolloutList,
+} from './types';
 import { paginatedClusterList, paginatedNamespacedList } from './pagination';
 import { k8sApi } from '../../cluster';
 import {
@@ -18,12 +22,12 @@ export async function paginatedNamespacedArgoRolloutList(
   namespace: string,
 ): Promise<{
   response: IncomingMessage;
-  body: RolloutList;
+  body: V1alpha1RolloutList;
 }> {
-  const rolloutList = new RolloutList();
+  const rolloutList = new V1alpha1RolloutList();
   rolloutList.apiVersion = 'argoproj.io/v1alpha1';
   rolloutList.kind = 'RolloutList';
-  rolloutList.items = new Array<Rollout>();
+  rolloutList.items = new Array<V1alpha1Rollout>();
 
   return await paginatedNamespacedList(
     namespace,
@@ -54,12 +58,12 @@ export async function paginatedNamespacedArgoRolloutList(
 
 export async function paginatedClusterArgoRolloutList(): Promise<{
   response: IncomingMessage;
-  body: RolloutList;
+  body: V1alpha1RolloutList;
 }> {
-  const rolloutList = new RolloutList();
+  const rolloutList = new V1alpha1RolloutList();
   rolloutList.apiVersion = 'argoproj.io/v1';
   rolloutList.kind = 'RolloutList';
-  rolloutList.items = new Array<Rollout>();
+  rolloutList.items = new Array<V1alpha1Rollout>();
 
   return await paginatedClusterList(
     rolloutList,
@@ -84,7 +88,9 @@ export async function paginatedClusterArgoRolloutList(): Promise<{
   );
 }
 
-export async function ArgoRolloutWatchHandler(rollout: Rollout): Promise<void> {
+export async function argoRolloutWatchHandler(
+  rollout: V1alpha1Rollout,
+): Promise<void> {
   rollout = trimWorkload(rollout);
 
   if (

src/supervisor/watchers/handlers/informer-config.ts

@@ -152,7 +152,7 @@ export const workloadWatchMetadata: Readonly<IWorkloadWatchMetadata> = {
     namespacedEndpoint:
       '/apis/argoproj.io/v1alpha1/watch/namespaces/{namespace}/rollouts',
     handlers: {
-      [DELETE]: rollout.ArgoRolloutWatchHandler,
+      [DELETE]: rollout.argoRolloutWatchHandler,
     },
     clusterListFactory: () => () => rollout.paginatedClusterArgoRolloutList(),
     namespacedListFactory: (namespace) => () =>

src/supervisor/watchers/handlers/types.ts

@@ -60,26 +60,28 @@ export interface V1DeploymentConfigStatus {
   observedGeneration?: number;
 }
 
-export class RolloutList implements KubernetesListObject<Rollout> {
+export class V1alpha1RolloutList
+  implements KubernetesListObject<V1alpha1Rollout>
+{
   'apiVersion'?: string;
-  'items': Array<Rollout>;
+  'items': Array<V1alpha1Rollout>;
   'kind'?: string;
   'metadata'?: V1ListMeta;
 }
 
-export interface Rollout extends KubernetesObject {
+export interface V1alpha1Rollout extends KubernetesObject {
   apiVersion?: string;
   kind?: string;
   metadata?: V1ObjectMeta;
-  spec?: RolloutSpec;
-  status?: RolloutStatus;
+  spec?: V1alpha1RolloutSpec;
+  status?: V1alpha1RolloutStatus;
 }
 
-export interface RolloutSpec {
+export interface V1alpha1RolloutSpec {
   template: V1PodTemplateSpec;
 }
 
-export interface RolloutStatus {
+export interface V1alpha1RolloutStatus {
   observedGeneration?: number;
 }
 

src/supervisor/workload-reader.ts

@@ -4,7 +4,7 @@ import * as kubernetesApiWrappers from './kuberenetes-api-wrappers';
 import { k8sApi } from './cluster';
 import { IKubeObjectMetadata, WorkloadKind } from './types';
 import { logger } from '../common/logger';
-import { Rollout, V1DeploymentConfig } from './watchers/handlers/types';
+import { V1alpha1Rollout, V1DeploymentConfig } from './watchers/handlers/types';
 import { trimWorkload } from './workload-sanitization';
 
 type IKubeObjectMetadataWithoutPodSpec = Omit<IKubeObjectMetadata, 'podSpec'>;
@@ -294,7 +294,7 @@ const argoRolloutReader: IWorkloadReaderFunc = async (
         workloadName,
       ),
   );
-  const rollout: Rollout = trimWorkload(rolloutResult.body);
+  const rollout: V1alpha1Rollout = trimWorkload(rolloutResult.body);
 
   if (
     !rollout.metadata ||

src/transmitter/payload.ts

@@ -150,7 +150,7 @@ const workloadKindMap = {
   replicationcontroller: 'ReplicationController',
   deploymentconfig: 'DeploymentConfig',
   pod: 'Pod',
-  rollout: 'Rollout', // TODO: Verify if supported
+  rollout: 'Rollout',
 };
 export function constructRuntimeData(
   runtimeResults: IRuntimeImage[],

test/system/kind.spec.ts

@@ -167,6 +167,12 @@ test('Kubernetes-Monitor with KinD', async (jestDoneCallback) => {
       code: 'ECONNRESET',
     });
 
+  nock(/https\:\/\/127\.0\.0\.1\:\d+/)
+    .get('/apis/argoproj.io/v1alpha1/rollouts')
+    .query(true)
+    .times(1)
+    .reply(200);
+
   nock('https://kubernetes-upstream.snyk.io')
     .post('/api/v1/workload')
     .times(1)