chore: skip tests that cannot work on Windows

WARNING! The reason some of these tests cannot run is because they rely on images that are not multi-arch (i.e. only have Linux variants and not Windows). The tests need to be reworked so that we verify:
- that we cannot pull them with Docker on Windows
- but we can pull them with our docker-pull library

Author: ivanstanev

test/lib/analyzer/image-inspector.test.ts

@@ -2,6 +2,7 @@
 // tslint:disable:object-literal-key-quotes
 
 import * as fs from "fs";
+import { platform } from "os";
 import * as path from "path";
 import * as sinon from "sinon";
 import { test } from "tap";
@@ -123,6 +124,10 @@ test("get image as an archive", async (t) => {
   const targetImage = "library/hello-world:latest";
 
   t.test("from the local daemon if it exists", async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const customPath = "./other_custom/image/save/path/local/daemon";
     const imageSavePath = path.join(customPath, uuidv4());
     const dockerPullSpy = sinon.spy(Docker.prototype, "pull");
@@ -167,6 +172,10 @@ test("get image as an archive", async (t) => {
   });
 
   t.test("from remote registry with binary", async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const customPath = tmp.dirSync().name;
     const imageSavePath = path.join(customPath, uuidv4());
     const dockerPullSpy = sinon.spy(Docker.prototype, "pull");
@@ -208,6 +217,10 @@ test("get image as an archive", async (t) => {
   });
 
   t.test("from remote registry without binary", async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const customPath = "./new_custom/image/save/path";
     const imageSavePath = path.join(customPath, uuidv4());
     const dockerPullSpy = sinon.spy(Docker.prototype, "pull");
@@ -251,6 +264,10 @@ test("get image as an archive", async (t) => {
   });
 
   t.test("from remote registry with authentication", async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const customPath = "./my_custom/image/save/path/auth";
     const imageSavePath = path.join(customPath, uuidv4());
     const dockerPullSpy: sinon.SinonSpy = sinon.spy(Docker.prototype, "pull");

test/lib/docker.test.ts

@@ -1,12 +1,13 @@
 import * as crypto from "crypto";
 import { createReadStream, existsSync, readFileSync, unlinkSync } from "fs";
 import * as os from "os";
+import { platform } from "os";
 import * as path from "path";
 import * as sinon from "sinon";
 import { test } from "tap";
-import * as subProcess from "../../lib/sub-process";
 
 import { Docker } from "../../lib/docker";
+import * as subProcess from "../../lib/sub-process";
 
 function getChecksum(path: string): Promise<string> {
   return new Promise((resolve, reject) => {
@@ -28,6 +29,10 @@ function getChecksum(path: string): Promise<string> {
 }
 
 test("docker run", async (t) => {
+  if (platform() !== "linux") {
+    return;
+  }
+
   const stub = sinon.stub(subProcess, "execute");
   stub.resolves("text");
   t.beforeEach(async () => {
@@ -88,6 +93,10 @@ test("docker run", async (t) => {
 });
 
 test("save from docker daemon", async (t) => {
+  if (platform() !== "linux") {
+    return;
+  }
+
   const targetImage = "hello-world:latest";
   const docker = new Docker(targetImage);
   const loadImage = path.join(
@@ -142,6 +151,10 @@ test("save from docker daemon", async (t) => {
 });
 
 test("safeCat", async (t) => {
+  if (platform() !== "linux") {
+    return;
+  }
+
   const stub = sinon.stub(subProcess, "execute");
   t.beforeEach(async () => {
     stub.resetHistory();
@@ -181,6 +194,10 @@ test("safeCat", async (t) => {
 });
 
 test("safeLs", async (t) => {
+  if (platform() !== "linux") {
+    return;
+  }
+
   const stub = sinon.stub(subProcess, "execute");
   t.beforeEach(async () => {
     stub.resetHistory();
@@ -253,6 +270,10 @@ const getLSOutputFixture = (file: string) =>
   path.join(__dirname, "../fixtures/ls-output", file);
 
 test("findGlobs", async (t) => {
+  if (platform() !== "linux") {
+    return;
+  }
+
   const stub = sinon.stub(subProcess, "execute");
   t.beforeEach(async () => {
     stub.resetHistory();

test/lib/ls-utils.test.ts

@@ -1,3 +1,4 @@
+import { platform } from "os";
 import * as path from "path";
 import { test } from "tap";
 import { iterateFiles, parseLsOutput } from "../../lib/ls-utils";
@@ -214,6 +215,10 @@ const PARSER_TESTS = [
 ];
 
 test("parse ls output", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   for (const data of PARSER_TESTS) {
     t.test(data.name, async (t) => {
       const res = parseLsOutput(data.in);

test/system/static.test.ts

@@ -408,6 +408,10 @@ test("static analysis for distroless base-debian10", async (t) => {
 });
 
 test("experimental static analysis for debian images", async (t) => {
+  if (os.platform() === "win32") {
+    return;
+  }
+
   const dockerSaveStub = sinon.stub(Docker.prototype, "save").callThrough();
 
   t.teardown(() => {
@@ -473,6 +477,10 @@ test("experimental static analysis for debian images", async (t) => {
 });
 
 test("static and dynamic scanning results are aligned", async (t) => {
+  if (os.platform() === "win32") {
+    return;
+  }
+
   const imageNameAndTag = "debian:10";
   const dockerfile = undefined;
   const manifestGlobs = [

test/system/system.test.ts

@@ -1,3 +1,4 @@
+import { platform } from "os";
 import * as path from "path";
 import { test } from "tap";
 
@@ -13,7 +14,11 @@ import {
 const getDockerfileFixturePath = (folder) =>
   path.join(__dirname, "../fixtures/dockerfiles/library", folder, "Dockerfile");
 
-test("attempt to connect to non-existent host", (t) => {
+test("attempt to connect to non-existent host", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const host = "does-not-exist:1234";
   const options = { host };
 
@@ -48,6 +53,10 @@ test("inspect an image that does not exist and is not pullable", (t) => {
 });
 
 test("inspect an image with an unsupported pkg manager", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "archlinux/base@sha256";
   const imgTag =
     "42b6236b8f1b85a3bea6c8055f7e290f503440f722c9b4f82cc04bdcf3bcfcef";
@@ -67,6 +76,10 @@ test("inspect an image with an unsupported pkg manager", async (t) => {
 });
 
 test("inspect a scratch image", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "busybox";
   const imgTag = "1.31.1";
   const img = imgName + ":" + imgTag;
@@ -84,7 +97,11 @@ test("inspect a scratch image", async (t) => {
   t.same(pluginResult.plugin.packageManager, "linux", "package manager linux");
 });
 
-test("inspect node:6.14.2 - provider and regular pkg as same dependency", (t) => {
+test("inspect node:6.14.2 - provider and regular pkg as same dependency", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "node";
   const imgTag = "6.14.2";
   const img = imgName + ":" + imgTag;
@@ -189,7 +206,11 @@ test("inspect node:6.14.2 - provider and regular pkg as same dependency", (t) =>
     });
 });
 
-test("inspect nginx:1.13.10", (t) => {
+test("inspect nginx:1.13.10", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "nginx";
   const imgTag = "1.13.10";
   const img = imgName + ":" + imgTag;
@@ -344,7 +365,11 @@ test("inspect nginx:1.13.10", (t) => {
     });
 });
 
-test("inspect redis:3.2.11-alpine", (t) => {
+test("inspect redis:3.2.11-alpine", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "redis";
   const imgTag = "3.2.11-alpine";
   const img = imgName + ":" + imgTag;
@@ -581,6 +606,10 @@ test("inspect redis:3.2.11-alpine", (t) => {
 test(
   "inspect image with hostname " + "localhost:5000/redis:3.2.11-alpine",
   async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const imgName = "redis";
     const imgTag = "3.2.11-alpine";
     const img = imgName + ":" + imgTag;
@@ -614,6 +643,10 @@ test(
 );
 
 test("inspect image with sha@256 " + "ubuntu@sha256", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "ubuntu";
   const imgTag = "";
   const imgSha =
@@ -644,6 +677,10 @@ test(
   "inspect image with hostname plus additional namespacing: " +
     "localhost:5000/redis:3.2.11-alpine",
   async (t) => {
+    if (platform() === "win32") {
+      return;
+    }
+
     const imgName = "redis";
     const imgTag = "3.2.11-alpine";
     const img = imgName + ":" + imgTag;
@@ -667,7 +704,11 @@ test(
   },
 );
 
-test("inspect centos", (t) => {
+test("inspect centos", async (t) => {
+  if (platform() === "win32") {
+    return;
+  }
+
   const imgName = "centos";
   const imgTag = "7.4.1708";
   const img = imgName + ":" + imgTag;