convert built-in package tests

openupm · Aug 15, 2024 · 2e66bbb · 2e66bbb
1 parent 45c56f7
commit 2e66bbb
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 86 deletions.
diff --git a/test/unit/domain/data-packument.ts → test/data-packument.ts b/test/unit/domain/data-packument.ts → test/data-packument.ts
@@ -1,11 +1,11 @@
 import assert from "assert";
-import { DomainName } from "../../../src/domain/domain-name";
-import { SemanticVersion } from "../../../src/domain/semantic-version";
+import { DomainName } from "../src/domain/domain-name";
+import { SemanticVersion } from "../src/domain/semantic-version";
 import {
   UnityPackument,
   UnityPackumentVersion,
-} from "../../../src/domain/packument";
-import { isZod } from "../../../src/utils/zod-utils";
+} from "../src/domain/packument";
+import { isZod } from "../src/utils/zod-utils";
 
 /**
  * Builder class for {@link UnityPackumentVersion}.

diff --git a/test/integration/docs.mock.ts b/test/integration/docs.mock.ts
@@ -0,0 +1,12 @@
+import nock from "nock";
+import { DomainName } from "../../src/domain/domain-name";
+
+/**
+ * Mocks the existence of a Unity documentation page for a package.
+ * @param packageName The name of the package.
+ */
+export function mockUnityDocPage(packageName: DomainName) {
+  nock(`https://docs.unity3d.com`)
+    .head(`/Manual/${packageName}.html`)
+    .reply(200);
+}
diff --git a/test/integration/registry.mock.ts b/test/integration/registry.mock.ts
@@ -0,0 +1,23 @@
+import nock from "nock";
+import { UnityPackument } from "../../src/domain/packument";
+import { RegistryUrl, unityRegistryUrl } from "../../src/domain/registry-url";
+
+/**
+ * Mocks a packument on a remote package registry.
+ * @param registryUrl The url of the registry.
+ * @param packument The packument.
+ */
+export function mockRegistryPackument(
+  registryUrl: RegistryUrl,
+  packument: UnityPackument
+) {
+  nock(registryUrl).get(`/${packument.name}`).reply(200, packument);
+}
+
+/**
+ * Mocks a packument on the Unity package registry.
+ * @param packument The packument.
+ */
+export function mockUnityRegistryPackument(packument: UnityPackument) {
+  mockRegistryPackument(unityRegistryUrl, packument);
+}
diff --git a/test/integration/services/built-in-package-check.test.ts b/test/integration/services/built-in-package-check.test.ts
@@ -0,0 +1,43 @@
+import nock from "nock";
+import { DomainName } from "../../../src/domain/domain-name";
+import { SemanticVersion } from "../../../src/domain/semantic-version";
+import { checkIsBuiltInPackage } from "../../../src/services/built-in-package-check";
+import { buildPackument } from "../../data-packument";
+import { mockUnityDocPage } from "../docs.mock";
+import { mockUnityRegistryPackument } from "../registry.mock";
+
+describe("check Unity package is built-in", () => {
+  const somePackage = DomainName.parse("com.some.package");
+  const someVersion = SemanticVersion.parse("1.0.0");
+
+  beforeEach(() => {
+    nock.cleanAll();
+  });
+
+  it("should be false if package is not a Unity package", async () => {
+    const actual = await checkIsBuiltInPackage(somePackage, someVersion);
+
+    expect(actual).toBeFalsy();
+  });
+
+  it("should be false if package is Unity package and exists on Unity registry", async () => {
+    mockUnityDocPage(somePackage);
+    mockUnityRegistryPackument(
+      buildPackument(somePackage, (packument) =>
+        packument.addVersion(someVersion)
+      )
+    );
+
+    const actual = await checkIsBuiltInPackage(somePackage, someVersion);
+
+    expect(actual).toBeFalsy();
+  });
+
+  it("should be true if package is Unity package, but does not exist on Unity registry", async () => {
+    mockUnityDocPage(somePackage);
+
+    const actual = await checkIsBuiltInPackage(somePackage, someVersion);
+
+    expect(actual).toBeTruthy();
+  });
+});
diff --git a/test/unit/cli/cmd-add.test.ts b/test/unit/cli/cmd-add.test.ts
@@ -31,7 +31,7 @@ import {
 } from "../../../src/services/get-registry-packument-version";
 import { Env, ParseEnv } from "../../../src/services/parse-env";
 import { AsyncErr, AsyncOk } from "../../../src/utils/result-utils";
-import { buildPackument } from "../domain/data-packument";
+import { buildPackument } from "../../data-packument";
 import { buildProjectManifest } from "../domain/data-project-manifest";
 import { exampleRegistryUrl } from "../domain/data-registry";
 import { mockResolvedPackuments } from "../services/remote-packuments.mock";

diff --git a/test/unit/cli/cmd-view.test.ts b/test/unit/cli/cmd-view.test.ts
@@ -7,7 +7,7 @@ import { SemanticVersion } from "../../../src/domain/semantic-version";
 import { GetRegistryPackument } from "../../../src/io/packument-io";
 import { GetRegistryAuth } from "../../../src/services/get-registry-auth";
 import { Env, ParseEnv } from "../../../src/services/parse-env";
-import { buildPackument } from "../domain/data-packument";
+import { buildPackument } from "../../data-packument";
 import { exampleRegistryUrl } from "../domain/data-registry";
 import { mockService } from "../services/service.mock";
 import { makeMockLogger } from "./log.mock";

diff --git a/test/unit/domain/packument.test.ts b/test/unit/domain/packument.test.ts
@@ -6,7 +6,7 @@ import {
   VersionNotFoundError,
 } from "../../../src/domain/packument";
 import { SemanticVersion } from "../../../src/domain/semantic-version";
-import { buildPackument } from "./data-packument";
+import { buildPackument } from "../../data-packument";
 import { DomainName } from "../../../src/domain/domain-name";
 
 describe("packument", () => {

diff --git a/test/unit/io/packument-io.test.ts b/test/unit/io/packument-io.test.ts
@@ -3,7 +3,7 @@ import { DomainName } from "../../../src/domain/domain-name";
 import { Registry } from "../../../src/domain/registry";
 import { FetchRegistryPackument } from "../../../src/io/packument-io";
 import { noopLogger } from "../../../src/logging";
-import { buildPackument } from "../domain/data-packument";
+import { buildPackument } from "../../data-packument";
 import { exampleRegistryUrl } from "../domain/data-registry";
 import { mockRegClientGetResult } from "../services/registry-client.mock";
 

diff --git a/test/unit/services/built-in-package-check.test.ts b/test/unit/services/built-in-package-check.test.ts
diff --git a/test/unit/services/get-registry-packument-version.test.ts b/test/unit/services/get-registry-packument-version.test.ts
@@ -4,7 +4,7 @@ import { Registry } from "../../../src/domain/registry";
 import { SemanticVersion } from "../../../src/domain/semantic-version";
 import { GetRegistryPackument } from "../../../src/io/packument-io";
 import { FetchRegistryPackumentVersion } from "../../../src/services/get-registry-packument-version";
-import { buildPackument } from "../domain/data-packument";
+import { buildPackument } from "../../data-packument";
 import { exampleRegistryUrl } from "../domain/data-registry";
 import { mockService } from "./service.mock";