|
| 1 | +import type { Package } from "@dpkit/metadata" |
| 2 | +import * as metadataModule from "@dpkit/metadata" |
| 3 | +import { beforeEach, describe, expect, it, vi } from "vitest" |
| 4 | +import { DescriptorPlugin } from "./plugin.ts" |
| 5 | + |
| 6 | +vi.mock("@dpkit/metadata", async () => { |
| 7 | + const actual = await vi.importActual("@dpkit/metadata") |
| 8 | + return { |
| 9 | + ...actual, |
| 10 | + loadPackageDescriptor: vi.fn(), |
| 11 | + savePackageDescriptor: vi.fn(), |
| 12 | + } |
| 13 | +}) |
| 14 | + |
| 15 | +describe("DescriptorPlugin", () => { |
| 16 | + let plugin: DescriptorPlugin |
| 17 | + let mockLoadPackageDescriptor: ReturnType<typeof vi.fn> |
| 18 | + let mockSavePackageDescriptor: ReturnType<typeof vi.fn> |
| 19 | + |
| 20 | + beforeEach(() => { |
| 21 | + plugin = new DescriptorPlugin() |
| 22 | + mockLoadPackageDescriptor = vi.mocked(metadataModule.loadPackageDescriptor) |
| 23 | + mockSavePackageDescriptor = vi.mocked(metadataModule.savePackageDescriptor) |
| 24 | + vi.clearAllMocks() |
| 25 | + }) |
| 26 | + |
| 27 | + describe("loadPackage", () => { |
| 28 | + it("should load package from local datapackage.json file", async () => { |
| 29 | + const mockPackage: Package = { |
| 30 | + name: "test-package", |
| 31 | + resources: [{ name: "test", data: [] }], |
| 32 | + } |
| 33 | + mockLoadPackageDescriptor.mockResolvedValue(mockPackage) |
| 34 | + |
| 35 | + const result = await plugin.loadPackage("./datapackage.json") |
| 36 | + |
| 37 | + expect(mockLoadPackageDescriptor).toHaveBeenCalledWith( |
| 38 | + "./datapackage.json", |
| 39 | + ) |
| 40 | + expect(result).toEqual(mockPackage) |
| 41 | + }) |
| 42 | + |
| 43 | + it("should load package from local json file", async () => { |
| 44 | + const mockPackage: Package = { |
| 45 | + name: "test-package", |
| 46 | + resources: [{ name: "test", data: [] }], |
| 47 | + } |
| 48 | + mockLoadPackageDescriptor.mockResolvedValue(mockPackage) |
| 49 | + |
| 50 | + const result = await plugin.loadPackage("./package.json") |
| 51 | + |
| 52 | + expect(mockLoadPackageDescriptor).toHaveBeenCalledWith("./package.json") |
| 53 | + expect(result).toEqual(mockPackage) |
| 54 | + }) |
| 55 | + |
| 56 | + it("should return undefined for remote json urls", async () => { |
| 57 | + const result = await plugin.loadPackage( |
| 58 | + "https://example.com/datapackage.json", |
| 59 | + ) |
| 60 | + |
| 61 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 62 | + expect(result).toBeUndefined() |
| 63 | + }) |
| 64 | + |
| 65 | + it("should return undefined for http remote json urls", async () => { |
| 66 | + const result = await plugin.loadPackage( |
| 67 | + "http://example.com/datapackage.json", |
| 68 | + ) |
| 69 | + |
| 70 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 71 | + expect(result).toBeUndefined() |
| 72 | + }) |
| 73 | + |
| 74 | + it("should return undefined for local csv files", async () => { |
| 75 | + const result = await plugin.loadPackage("./data.csv") |
| 76 | + |
| 77 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 78 | + expect(result).toBeUndefined() |
| 79 | + }) |
| 80 | + |
| 81 | + it("should return undefined for local xlsx files", async () => { |
| 82 | + const result = await plugin.loadPackage("./data.xlsx") |
| 83 | + |
| 84 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 85 | + expect(result).toBeUndefined() |
| 86 | + }) |
| 87 | + |
| 88 | + it("should return undefined for local parquet files", async () => { |
| 89 | + const result = await plugin.loadPackage("./data.parquet") |
| 90 | + |
| 91 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 92 | + expect(result).toBeUndefined() |
| 93 | + }) |
| 94 | + |
| 95 | + it("should handle absolute paths", async () => { |
| 96 | + const mockPackage: Package = { |
| 97 | + name: "test-package", |
| 98 | + resources: [{ name: "test", data: [] }], |
| 99 | + } |
| 100 | + mockLoadPackageDescriptor.mockResolvedValue(mockPackage) |
| 101 | + |
| 102 | + const result = await plugin.loadPackage("/absolute/path/datapackage.json") |
| 103 | + |
| 104 | + expect(mockLoadPackageDescriptor).toHaveBeenCalledWith( |
| 105 | + "/absolute/path/datapackage.json", |
| 106 | + ) |
| 107 | + expect(result).toEqual(mockPackage) |
| 108 | + }) |
| 109 | + |
| 110 | + it("should return undefined for github urls", async () => { |
| 111 | + const result = await plugin.loadPackage( |
| 112 | + "https://github.com/owner/repo/datapackage.json", |
| 113 | + ) |
| 114 | + |
| 115 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 116 | + expect(result).toBeUndefined() |
| 117 | + }) |
| 118 | + |
| 119 | + it("should return undefined for zenodo urls", async () => { |
| 120 | + const result = await plugin.loadPackage("https://zenodo.org/record/123") |
| 121 | + |
| 122 | + expect(mockLoadPackageDescriptor).not.toHaveBeenCalled() |
| 123 | + expect(result).toBeUndefined() |
| 124 | + }) |
| 125 | + }) |
| 126 | + |
| 127 | + describe("savePackage", () => { |
| 128 | + const mockPackage: Package = { |
| 129 | + name: "test-package", |
| 130 | + resources: [{ name: "test", data: [] }], |
| 131 | + } |
| 132 | + |
| 133 | + it("should save package to local datapackage.json file", async () => { |
| 134 | + mockSavePackageDescriptor.mockResolvedValue(undefined) |
| 135 | + |
| 136 | + const result = await plugin.savePackage(mockPackage, { |
| 137 | + target: "./datapackage.json", |
| 138 | + }) |
| 139 | + |
| 140 | + expect(mockSavePackageDescriptor).toHaveBeenCalledWith(mockPackage, { |
| 141 | + path: "./datapackage.json", |
| 142 | + }) |
| 143 | + expect(result).toEqual({ path: "./datapackage.json" }) |
| 144 | + }) |
| 145 | + |
| 146 | + it("should save package with absolute path", async () => { |
| 147 | + mockSavePackageDescriptor.mockResolvedValue(undefined) |
| 148 | + |
| 149 | + const result = await plugin.savePackage(mockPackage, { |
| 150 | + target: "/absolute/path/datapackage.json", |
| 151 | + }) |
| 152 | + |
| 153 | + expect(mockSavePackageDescriptor).toHaveBeenCalledWith(mockPackage, { |
| 154 | + path: "/absolute/path/datapackage.json", |
| 155 | + }) |
| 156 | + expect(result).toEqual({ path: "/absolute/path/datapackage.json" }) |
| 157 | + }) |
| 158 | + |
| 159 | + it("should return undefined for remote urls", async () => { |
| 160 | + const result = await plugin.savePackage(mockPackage, { |
| 161 | + target: "https://example.com/datapackage.json", |
| 162 | + }) |
| 163 | + |
| 164 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 165 | + expect(result).toBeUndefined() |
| 166 | + }) |
| 167 | + |
| 168 | + it("should return undefined for local json files not named datapackage.json", async () => { |
| 169 | + const result = await plugin.savePackage(mockPackage, { |
| 170 | + target: "./package.json", |
| 171 | + }) |
| 172 | + |
| 173 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 174 | + expect(result).toBeUndefined() |
| 175 | + }) |
| 176 | + |
| 177 | + it("should return undefined for local csv files", async () => { |
| 178 | + const result = await plugin.savePackage(mockPackage, { |
| 179 | + target: "./data.csv", |
| 180 | + }) |
| 181 | + |
| 182 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 183 | + expect(result).toBeUndefined() |
| 184 | + }) |
| 185 | + |
| 186 | + it("should return undefined for local xlsx files", async () => { |
| 187 | + const result = await plugin.savePackage(mockPackage, { |
| 188 | + target: "./data.xlsx", |
| 189 | + }) |
| 190 | + |
| 191 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 192 | + expect(result).toBeUndefined() |
| 193 | + }) |
| 194 | + |
| 195 | + it("should return undefined for http urls", async () => { |
| 196 | + const result = await plugin.savePackage(mockPackage, { |
| 197 | + target: "http://example.com/datapackage.json", |
| 198 | + }) |
| 199 | + |
| 200 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 201 | + expect(result).toBeUndefined() |
| 202 | + }) |
| 203 | + |
| 204 | + it("should ignore withRemote option for local files", async () => { |
| 205 | + mockSavePackageDescriptor.mockResolvedValue(undefined) |
| 206 | + |
| 207 | + const result = await plugin.savePackage(mockPackage, { |
| 208 | + target: "./datapackage.json", |
| 209 | + withRemote: true, |
| 210 | + }) |
| 211 | + |
| 212 | + expect(mockSavePackageDescriptor).toHaveBeenCalledWith(mockPackage, { |
| 213 | + path: "./datapackage.json", |
| 214 | + }) |
| 215 | + expect(result).toEqual({ path: "./datapackage.json" }) |
| 216 | + }) |
| 217 | + |
| 218 | + it("should return undefined for local directories", async () => { |
| 219 | + const result = await plugin.savePackage(mockPackage, { |
| 220 | + target: "./data", |
| 221 | + }) |
| 222 | + |
| 223 | + expect(mockSavePackageDescriptor).not.toHaveBeenCalled() |
| 224 | + expect(result).toBeUndefined() |
| 225 | + }) |
| 226 | + }) |
| 227 | +}) |
0 commit comments