chore: kubectl describe resources in OS4 tests for diagnosing errors

Author: ivanstanev

test/helpers/kubectl.ts

@@ -117,6 +117,11 @@ export async function deletePod(podName: string, namespace: string) {
   console.log(`Deleted pod ${podName}`);
 }
 
+export async function describeKubernetesResource(kind: string, name: string, namespace: string): Promise<string> {
+  const result = await exec(`./kubectl describe ${kind} ${name} -n ${namespace}`);
+  return result.stdout;
+}
+
 export async function getDeploymentJson(deploymentName: string, namespace: string): Promise<any> {
   const getDeploymentResult = await exec(`./kubectl get deployment ${deploymentName} -n ${namespace} -o json`);
   return JSON.parse(getDeploymentResult.stdout);
@@ -143,7 +148,7 @@ export async function getPodLogs(podName: string, namespace: string): Promise<an
 
 export async function waitForDeployment(name: string, namespace: string): Promise<void> {
   console.log(`Trying to find deployment ${name} in namespace ${namespace}`);
-  for (let attempt = 0; attempt < 60; attempt++) {
+  for (let attempt = 0; attempt < 120; attempt++) {
     try {
       await exec(`./kubectl get deployment.apps/${name} -n ${namespace}`);
     } catch (error) {

test/setup/platforms/openshift4.ts

@@ -58,7 +58,28 @@ export async function exportKubeConfig(): Promise<void> {
   process.env.KUBECONFIG = kubeconfigPath;
 }
 
+async function tryDescribingResourceToFile(kind: string, name: string, namespace: string): Promise<void> {
+  return kubectl.describeKubernetesResource(kind, name, namespace)
+    .then((description) => {
+      const fileName = `${kind}-${name}-${namespace}`;
+      const filePath = process.env.CI
+        // The directory is generated by CircleCI config (see .circleci/config.yml).
+        ? `/tmp/logs/test/integration/openshift4/${fileName}`
+        : `${tmpdir()}/${fileName}`;
+      writeFileSync(filePath, description);
+      console.log(`Description for ${kind} ${name} is stored in ${filePath}`);
+    })
+    .catch(() => console.log(`Could not describe ${kind} ${name} in namespace ${namespace}`));
+}
+
 export async function clean(): Promise<void> {
+  await Promise.all([
+    tryDescribingResourceToFile('deployment', 'snyk-operator', 'snyk-monitor'),
+    tryDescribingResourceToFile('deployment', 'snyk-monitor', 'snyk-monitor'),
+    tryDescribingResourceToFile('operatorsource', 'snyk-operator', 'openshift-marketplace'),
+    tryDescribingResourceToFile('subscription', 'snyk-operator', 'snyk-monitor'),
+  ]);
+
   // Kubernetes will be stuck trying to delete these resources if we don't clear the finalizers.
   await Promise.all([
     kubectl.patchResourceFinalizers('customresourcedefinition', 'snykmonitors.charts.helm.k8s.io', 'snyk-monitor').catch(() => undefined),