mirror of
https://github.com/tiennm99/is-a-dev.git
synced 2026-10-15 22:15:09 +00:00
feat(ci): validation
This commit is contained in:
William Harrison committed
1 parent
2b5e7afd99
commit
94d1338529
9 files changed
+538
-30
No files matched your search
@@ -0,0 +1,40 @@
|
||||
const t = require("ava");
|
||||
const fs = require("fs-extra");
|
||||
const path = require("path");
|
||||
|
||||
const domainsPath = path.resolve("domains");
|
||||
const files = fs.readdirSync(domainsPath);
|
||||
|
||||
// Nested subdomains should not exist if the parent subdomain does not exist
|
||||
t("Nested subdomains should not exist without a parent subdomain", (t) => {
|
||||
files.forEach((file) => {
|
||||
const subdomain = file.replace(".json", "");
|
||||
|
||||
if (subdomain.split(".").length > 1) {
|
||||
const parentSubdomain = subdomain.split(".").pop();
|
||||
|
||||
t.true(
|
||||
files.includes(`${parentSubdomain}.json`),
|
||||
`${file}: Parent subdomain does not exist`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
t.pass();
|
||||
});
|
||||
|
||||
// Nested subdomains should not exist if the parent subdomain has NS records
|
||||
t("Nested subdomains should not exist if the parent subdomain has NS records", (t) => {
|
||||
files.forEach((file) => {
|
||||
const subdomain = file.replace(".json", "");
|
||||
|
||||
if (subdomain.split(".").length > 1) {
|
||||
const parentSubdomain = subdomain.split(".").pop();
|
||||
const parentDomain = fs.readJsonSync(path.join(domainsPath, `${parentSubdomain}.json`));
|
||||
|
||||
t.is(parentDomain.record.NS, undefined, `${file}: Parent subdomain has NS records`);
|
||||
}
|
||||
});
|
||||
|
||||
t.pass();
|
||||
});
|
||||
@@ -0,0 +1,107 @@
|
||||
const t = require("ava");
|
||||
const fs = require("fs-extra");
|
||||
const path = require("path");
|
||||
|
||||
const requiredFields = {
|
||||
owner: "object",
|
||||
record: "object",
|
||||
};
|
||||
|
||||
const optionalFields = {
|
||||
proxied: "boolean",
|
||||
reserved: "boolean",
|
||||
};
|
||||
|
||||
const requiredOwnerFields = {
|
||||
username: "string",
|
||||
};
|
||||
|
||||
const optionalOwnerFields = {
|
||||
email: "string",
|
||||
};
|
||||
|
||||
const emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
|
||||
const hostnameRegex =
|
||||
/^(?=.{1,253}$)(?:(?:[_a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\.)+[a-zA-Z]{2,63}$/;
|
||||
|
||||
const domainsPath = path.resolve("domains");
|
||||
const files = fs.readdirSync(domainsPath);
|
||||
|
||||
const validateRequiredFields = (t, obj, requiredFields, file) => {
|
||||
Object.keys(requiredFields).forEach((key) => {
|
||||
t.true(obj.hasOwnProperty(key), `${file}: Missing required field: ${key}`);
|
||||
t.is(
|
||||
typeof obj[key],
|
||||
requiredFields[key],
|
||||
`${file}: Field ${key} should be of type ${requiredFields[key]}`
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
const validateOptionalFields = (t, obj, optionalFields, file) => {
|
||||
Object.keys(optionalFields).forEach((key) => {
|
||||
if (obj.hasOwnProperty(key)) {
|
||||
t.is(
|
||||
typeof obj[key],
|
||||
optionalFields[key],
|
||||
`${file}: Field ${key} should be of type ${optionalFields[key]}`
|
||||
);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
// Ensure all files are valid JSON
|
||||
t("All files should be valid JSON", (t) => {
|
||||
files.forEach((file) => {
|
||||
t.notThrows(() => fs.readJsonSync(path.join(domainsPath, file)), `${file}: Invalid JSON file`);
|
||||
});
|
||||
});
|
||||
|
||||
// Ensure all files have the required fields
|
||||
t("All files should have valid file names", (t) => {
|
||||
files.forEach((file) => {
|
||||
t.true(file.endsWith(".json"), `${file}: File does not have .json extension`);
|
||||
t.false(file.includes(".is-a.dev"), `${file}: File name should not contain .is-a.dev`);
|
||||
|
||||
// Ignore root domain
|
||||
if (file !== "@.json") {
|
||||
t.regex(
|
||||
file.replace(/\.json$/, "") + ".is-a.dev",
|
||||
hostnameRegex,
|
||||
`${file}: FQDN must be 1-253 characters, use letters, numbers, dots, or hyphens, and not start or end with a hyphen.`
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Ensure all files have the required fields
|
||||
t("All files should have the required fields", (t) => {
|
||||
files.forEach((file) => {
|
||||
const data = fs.readJsonSync(path.join(domainsPath, file));
|
||||
|
||||
validateRequiredFields(t, data, requiredFields, file);
|
||||
validateRequiredFields(t, data.owner, requiredOwnerFields, file);
|
||||
|
||||
if (!data.reserved) {
|
||||
t.true(Object.keys(data.record).length > 0, `${file}: No record types found`);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Validate the optional fields
|
||||
t("All files should have valid optional fields", (t) => {
|
||||
files.forEach((file) => {
|
||||
const data = fs.readJsonSync(path.join(domainsPath, file));
|
||||
|
||||
validateOptionalFields(t, data, optionalFields, file);
|
||||
validateOptionalFields(t, data.owner, optionalOwnerFields, file);
|
||||
|
||||
if (data.owner.email) {
|
||||
t.regex(
|
||||
data.owner.email,
|
||||
emailRegex,
|
||||
`${file}: Owner email should be a valid email address`
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,290 @@
|
||||
const t = require("ava");
|
||||
const fs = require("fs-extra");
|
||||
const path = require("path");
|
||||
|
||||
const { expandIPv6, isPublicIPv4, isPublicIPv6 } = require("../utils/functions");
|
||||
|
||||
const validRecordTypes = ["A", "AAAA", "CAA", "CNAME", "DS", "MX", "NS", "SRV", "TXT", "URL"];
|
||||
|
||||
const hostnameRegex =
|
||||
/^(?=.{1,253}$)(?:(?:[_a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\.)+[a-zA-Z]{2,63}$/;
|
||||
const ipv4Regex =
|
||||
/^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}$/;
|
||||
const ipv6Regex =
|
||||
/^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$|^::(?:[0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}$|^(?:[0-9a-fA-F]{1,4}:){1,7}:$|^(?:[0-9a-fA-F]{1,4}:){0,6}::(?:[0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4}$/;
|
||||
|
||||
const domainsPath = path.resolve("domains");
|
||||
const files = fs.readdirSync(domainsPath);
|
||||
|
||||
// Validate the record object key names
|
||||
t("All files should have valid record types", (t) => {
|
||||
files.forEach((file) => {
|
||||
const data = fs.readJsonSync(path.join(domainsPath, file));
|
||||
|
||||
const recordKeys = Object.keys(data.record);
|
||||
|
||||
recordKeys.forEach((key) => {
|
||||
t.true(validRecordTypes.includes(key), `${file}: Invalid record type: ${key}`);
|
||||
});
|
||||
|
||||
// CNAME records cannot be combined with any other record type
|
||||
if (recordKeys.includes("CNAME")) {
|
||||
t.is(recordKeys.length, Number(1), `${file}: CNAME records cannot be combined with other records`);
|
||||
}
|
||||
|
||||
// NS records cannot be combined with any other record type, except for DS records
|
||||
if (recordKeys.includes("NS")) {
|
||||
t.true(
|
||||
recordKeys.length === 1 || recordKeys.length === 2 && recordKeys.includes("DS"),
|
||||
`${file}: NS records cannot be combined with other records, except for DS records`
|
||||
);
|
||||
}
|
||||
|
||||
// DS records must be combined with NS records
|
||||
if (recordKeys.includes("DS")) {
|
||||
t.true(
|
||||
recordKeys.includes("NS"),
|
||||
`${file}: DS records must be combined with NS records`
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Ensure there are no duplicate keys in the record object
|
||||
t("All files should not have duplicate record keys", (t) => {
|
||||
files.forEach((file) => {
|
||||
const data = fs.readJsonSync(path.join(domainsPath, file));
|
||||
|
||||
const recordKeys = Object.keys(data.record);
|
||||
const uniqueRecordKeys = new Set(recordKeys);
|
||||
|
||||
t.is(recordKeys.length, uniqueRecordKeys.size, `${file}: Duplicate record keys found`);
|
||||
});
|
||||
});
|
||||
|
||||
// Validate the values of the record object's keys
|
||||
t("All files should have valid record values", (t) => {
|
||||
files.forEach((file) => {
|
||||
const data = fs.readJsonSync(path.join(domainsPath, file));
|
||||
|
||||
Object.keys(data.record).forEach((key) => {
|
||||
const value = data.record[key];
|
||||
|
||||
// These records must be an array of strings
|
||||
if (["A", "AAAA", "MX", "NS"].includes(key)) {
|
||||
t.true(Array.isArray(value), `${file}: Record value should be an array for ${key}`);
|
||||
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record === "string",
|
||||
`${file}: Record value should be a string for ${key}`
|
||||
);
|
||||
});
|
||||
|
||||
if (key === "A") {
|
||||
value.forEach((record) => {
|
||||
t.regex(
|
||||
record,
|
||||
ipv4Regex,
|
||||
`${file}: Record value should be a valid IPv4 address for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
isPublicIPv4(record, data.proxied),
|
||||
`${file}: Record value should be a public IPv4 address for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
if (key === "AAAA") {
|
||||
value.forEach((record) => {
|
||||
t.regex(
|
||||
expandIPv6(record),
|
||||
ipv6Regex,
|
||||
`${file}: Record value should be a valid IPv6 address for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
isPublicIPv6(record),
|
||||
`${file}: Record value should be a public IPv6 address for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
if (["MX", "NS"].includes(key)) {
|
||||
value.forEach((record) => {
|
||||
t.regex(
|
||||
record,
|
||||
hostnameRegex,
|
||||
`${file}: Record value should be a valid hostname for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// These records must be strings
|
||||
if (["CNAME", "URL"].includes(key)) {
|
||||
t.true(
|
||||
typeof value === "string",
|
||||
`${file}: Record value should be a string for ${key}`
|
||||
);
|
||||
|
||||
if (key === "CNAME") {
|
||||
t.regex(
|
||||
value,
|
||||
hostnameRegex,
|
||||
`${file}: Record value should be a valid hostname for ${key}`
|
||||
);
|
||||
}
|
||||
|
||||
if (key === "URL") {
|
||||
try {
|
||||
new URL(value);
|
||||
} catch (error) {
|
||||
t.fail(`${file}: Record value should be a valid URL for ${key}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// These records must be arrays of objects
|
||||
if (["CAA", "DS", "SRV"].includes(key)) {
|
||||
t.true(Array.isArray(value), `${file}: Record value should be an array for ${key}`);
|
||||
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record === "object",
|
||||
`${file}: Record value should be an object for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
|
||||
if (key === "CAA") {
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record.flags === "number",
|
||||
`${file}: CAA record value should have a number for flags at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.tag === "string",
|
||||
`${file}: CAA record value should have a string for tag at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.value === "string",
|
||||
`${file}: CAA record value should have a string for value at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
if (key === "DS") {
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record.key_tag === "number",
|
||||
`${file}: DS record value should have a number for key_tag at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.algorithm === "number",
|
||||
`${file}: DS record value should have a number for algorithm at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.digest_type === "number",
|
||||
`${file}: DS record value should have a number for digest_type at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.digest === "string",
|
||||
`${file}: DS record value should have a string for digest at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
if (key === "SRV") {
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record.priority === "number",
|
||||
`${file}: SRV record value should have a number for priority at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.weight === "number",
|
||||
`${file}: SRV record value should have a number for weight at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.port === "number",
|
||||
`${file}: SRV record value should have a number for port at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.true(
|
||||
typeof record.target === "string",
|
||||
`${file}: SRV record value should have a string for target at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
|
||||
t.regex(
|
||||
value.target,
|
||||
hostnameRegex,
|
||||
`${file}: SRV record value should be a valid hostname for target at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// TXT records must be either a string or array of strings
|
||||
if (key === "TXT") {
|
||||
if (Array.isArray(value)) {
|
||||
value.forEach((record) => {
|
||||
t.true(
|
||||
typeof record === "string",
|
||||
`${file}: Record value should be a string for ${key} at index ${value.indexOf(
|
||||
record
|
||||
)}`
|
||||
);
|
||||
});
|
||||
} else {
|
||||
t.true(
|
||||
typeof value === "string",
|
||||
`${file}: Record value should be a string for ${key}`
|
||||
);
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user