The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import {
compareVersions,
getDockerImage,
getHeadMajorVersion,
getMajorVersion,
getRollingTagMajorVersion,
getHeadDockerImage,
isHead,
isRollingTag,
isRollingTagEnterprise,
} from "./cross-version-helpers";
describe("cross-version-helpers", () => {
describe("predicates", () => {
describe("isHead", () => {
it("returns true for HEAD", () => {
expect(isHead("HEAD")).toBe(true);
});
it("returns false for other versions", () => {
expect(isHead("v1.59.0")).toBe(false);
expect(isHead("v0.58.x")).toBe(false);
expect(isHead("head")).toBe(false);
});
});
describe("isRollingTag", () => {
it("returns true for .x tags", () => {
expect(isRollingTag("v1.59.x")).toBe(true);
expect(isRollingTag("v0.58.x")).toBe(true);
});
it("returns false for specific versions", () => {
expect(isRollingTag("v1.59.0")).toBe(false);
expect(isRollingTag("HEAD")).toBe(false);
});
});
});
describe("pure helpers", () => {
describe("getHeadMajorVersion", () => {
it("returns currentVersion + 1", () => {
expect(getHeadMajorVersion("59")).toBe("60");
expect(getHeadMajorVersion("52")).toBe("53");
expect(getHeadMajorVersion("0")).toBe("1");
});
it("throws when currentVersion is empty", () => {
expect(() => getHeadMajorVersion("")).toThrow(
"currentVersion is required",
);
});
});
describe("getRollingTagMajorVersion", () => {
it("extracts major version from rolling tag", () => {
expect(getRollingTagMajorVersion("v1.59.x")).toBe("59");
expect(getRollingTagMajorVersion("v0.58.x")).toBe("58");
expect(getRollingTagMajorVersion("v1.50.x")).toBe("50");
});
it("throws for invalid rolling tags", () => {
expect(() => getRollingTagMajorVersion("v1.59.0")).toThrow(
"Invalid rolling tag",
);
expect(() => getRollingTagMajorVersion("HEAD")).toThrow(
"Invalid rolling tag",
);
});
});
describe("isRollingTagEnterprise", () => {
it("returns true for v1.x tags", () => {
expect(isRollingTagEnterprise("v1.59.x")).toBe(true);
expect(isRollingTagEnterprise("v1.50.x")).toBe(true);
});
it("returns false for v0.x tags", () => {
expect(isRollingTagEnterprise("v0.59.x")).toBe(false);
expect(isRollingTagEnterprise("v0.50.x")).toBe(false);
});
});
describe("getHeadDockerImage", () => {
const originalDigest = process.env.HEAD_DIGEST;
const originalEventName = process.env.GITHUB_EVENT_NAME;
beforeEach(() => {
delete process.env.GITHUB_EVENT_NAME;
});
afterEach(() => {
if (originalDigest === undefined) {
delete process.env.HEAD_DIGEST;
} else {
process.env.HEAD_DIGEST = originalDigest;
}
if (originalEventName === undefined) {
delete process.env.GITHUB_EVENT_NAME;
} else {
process.env.GITHUB_EVENT_NAME = originalEventName;
}
});
it("uses the latest tag when HEAD_DIGEST is not set", () => {
delete process.env.HEAD_DIGEST;
expect(getHeadDockerImage()).toBe(
"metabase/metabase-enterprise-head:latest",
);
});
it("uses the latest tag when HEAD_DIGEST is empty", () => {
process.env.HEAD_DIGEST = " ";
expect(getHeadDockerImage()).toBe(
"metabase/metabase-enterprise-head:latest",
);
});
it("pins to the digest when HEAD_DIGEST is set", () => {
process.env.HEAD_DIGEST = "sha256:abc123";
expect(getHeadDockerImage()).toBe(
"metabase/metabase-enterprise-head@sha256:abc123",
);
});
it("adds the sha256 prefix when the digest is bare", () => {
process.env.HEAD_DIGEST = "abc123";
expect(getHeadDockerImage()).toBe(
"metabase/metabase-enterprise-head@sha256:abc123",
);
});
it("uses metabase-dev when running from a pull request", () => {
process.env.GITHUB_EVENT_NAME = "pull_request";
process.env.HEAD_DIGEST = "sha256:abc123";
expect(getHeadDockerImage()).toBe(
"metabase/metabase-dev@sha256:abc123",
);
});
it("uses the enterprise head latest tag on a pull request without a digest", () => {
process.env.GITHUB_EVENT_NAME = "pull_request";
delete process.env.HEAD_DIGEST;
expect(getHeadDockerImage()).toBe(
"metabase/metabase-enterprise-head:latest",
);
});
});
});
describe("composed helpers", () => {
describe("getMajorVersion", () => {
it.each([
["v0.52.3", "52"],
["v1.52", "52"],
["v1.43.2.1", "43"],
// Rolling tags
["v1.59.x", "59"],
["v0.58.x", "58"],
])("%s -> %s", (input, expected) => {
expect(getMajorVersion(input)).toBe(expected);
});
it("handles HEAD when CURRENT_VERSION is set", () => {
const originalEnv = process.env.CURRENT_VERSION;
process.env.CURRENT_VERSION = "59";
try {
expect(getMajorVersion("HEAD")).toBe("60");
} finally {
process.env.CURRENT_VERSION = originalEnv;
}
});
it("throws for HEAD when CURRENT_VERSION is not set", () => {
const originalEnv = process.env.CURRENT_VERSION;
delete process.env.CURRENT_VERSION;
try {
expect(() => getMajorVersion("HEAD")).toThrow(
"CURRENT_VERSION env var must be set when using HEAD",
);
} finally {
process.env.CURRENT_VERSION = originalEnv;
}
});
});
describe("compareVersions", () => {
it.each([
// major version changes
["v0.50.0", "v0.51.0", "upgrade"],
["v0.57.13", "v0.58.7", "upgrade"],
["v0.51.0", "v0.50.0", "downgrade"],
["v0.58.7", "v0.57.13", "downgrade"],
// minor version changes
["v0.58.6", "v0.58.7", "upgrade"],
["v0.58.7", "v0.58.6", "downgrade"],
// patch version changes
["v0.50.13.5", "v0.50.13.6", "upgrade"],
["v0.50.13.6", "v0.50.13.5", "downgrade"],
["v0.50.13.5", "v0.50.13.5", "same"],
// patch to minor
["v0.50.13.5", "v0.50.14", "upgrade"],
["v0.50.14", "v0.50.13.5", "downgrade"],
// patch to major
["v0.50.13.5", "v0.51.0", "upgrade"],
["v0.51.0", "v0.50.13.5", "downgrade"],
// same versions
["v0.50.0", "v0.50.0", "same"],
["v0.58.7", "v0.58.7", "same"],
// ignores edition prefix (v0 vs v1)
["v1.58.6", "v0.58.7", "upgrade"],
["v0.58.7", "v1.58.6", "downgrade"],
// HEAD (always newer than any released version)
["HEAD", "HEAD", "same"],
["HEAD", "v0.59.0", "downgrade"],
["HEAD", "v1.59.0", "downgrade"],
["v0.59.0", "HEAD", "upgrade"],
["v1.59.0", "HEAD", "upgrade"],
// Rolling tags (.x)
["v1.58.x", "v1.59.x", "upgrade"],
["v1.59.x", "v1.58.x", "downgrade"],
["v1.59.x", "v1.59.x", "same"],
["v0.58.x", "v0.59.x", "upgrade"],
// Mixed rolling and specific
["v1.58.x", "v1.59.0", "upgrade"],
["v1.59.0", "v1.58.x", "downgrade"],
] as const)("%s -> %s = %s", (source, target, expected) => {
expect(compareVersions(source, target)).toBe(expected);
});
it("throws for invalid source version", () => {
expect(() => compareVersions("invalid", "v0.58.7")).toThrow(
"Invalid version string: invalid",
);
});
it("throws for invalid target version", () => {
expect(() => compareVersions("v0.58.7", "invalid")).toThrow(
"Invalid version string: invalid",
);
});
});
describe("getDockerImage", () => {
it.each([
// OSS versions (v0.x.x)
["v0.58.7", "metabase/metabase:v0.58.7"],
["v0.57.13", "metabase/metabase:v0.57.13"],
["v0.50.13.5", "metabase/metabase:v0.50.13.5"],
// EE versions (v1.x.x)
["v1.58.7", "metabase/metabase-enterprise:v1.58.7"],
["v1.57.13", "metabase/metabase-enterprise:v1.57.13"],
["v1.50.13.5", "metabase/metabase-enterprise:v1.50.13.5"],
// Rolling tags (.x)
["v0.59.x", "metabase/metabase:v0.59.x"],
["v1.59.x", "metabase/metabase-enterprise:v1.59.x"],
["v0.50.x", "metabase/metabase:v0.50.x"],
["v1.50.x", "metabase/metabase-enterprise:v1.50.x"],
] as const)("%s -> %s", (version, expected) => {
expect(getDockerImage(version)).toBe(expected);
});
it("throws for invalid version", () => {
expect(() => getDockerImage("invalid")).toThrow(
"Invalid version string: invalid",
);
});
it("returns enterprise HEAD image for HEAD", () => {
expect(getDockerImage("HEAD")).toBe(getHeadDockerImage());
});
});
});
});