kubepile 0.0.2 → 0.0.3

package/README.md

@@ -46,6 +46,13 @@ This reads `~/.config/kubepile/*.yaml`, then writes `~/.kube/config`. If
 `~/.kube/config` already exists, `kubepile compile` prompts before copying it to
 `~/.kube/config.bak`.
 
+Kubepile skips that backup prompt for safe rebuilds. A rebuild is safe when the
+existing generated kubeconfig can be reproduced from a subset of the current
+`*.yaml` files. In practice, this means no-op rebuilds and adding a new
+provider file do not ask for a backup. If the existing generated kubeconfig was
+manually edited, was not generated by kubepile, or can no longer be reproduced
+from the current inputs, kubepile asks before replacing it.
+
 Explicit command and options:
 
 ```sh

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "kubepile",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "Compile and split kubeconfig files from ~/.config/kubepile.",
     "type": "module",
     "main": "./dist/src/kubepile.js",

package/dist/src/kubepile.js

@@ -11,6 +11,9 @@ export function defaultKubeConfigPath() {
 export async function buildMergedConfig(options = {}) {
     const inputDir = options.inputDir ?? defaultKubepileDir();
     const inputFiles = await listKubeConfigFiles(inputDir);
+    return buildMergedConfigFromFiles(inputFiles);
+}
+async function buildMergedConfigFromFiles(inputFiles) {
     const configs = await Promise.all(inputFiles.map(async (filePath) => ({
         filePath,
         config: await readKubeConfigFile(filePath),
@@ -41,7 +44,7 @@ export async function compileToKubeConfig(options = {}) {
     const { config, inputFiles } = await buildMergedConfig({ ...options, inputDir });
     let backedUpTo;
     if (await pathExists(outputPath)) {
-        const shouldBackup = await options.shouldBackup?.(outputPath, backupPath);
+        const shouldBackup = await shouldBackUpExistingKubeConfig(outputPath, inputDir, inputFiles, options);
         if (shouldBackup) {
             await mkdir(path.dirname(backupPath), { recursive: true });
             await copyFile(outputPath, backupPath);
@@ -52,6 +55,52 @@ export async function compileToKubeConfig(options = {}) {
     await writeFile(outputPath, serializeGeneratedKubeConfig(config, inputDir), "utf8");
     return { config, inputFiles, outputPath, backedUpTo };
 }
+async function shouldBackUpExistingKubeConfig(outputPath, inputDir, currentInputFiles, options) {
+    if (await canSafelyRegenerate(outputPath, inputDir, currentInputFiles)) {
+        return false;
+    }
+    return Boolean(await options.shouldBackup?.(outputPath, `${outputPath}.bak`));
+}
+async function canSafelyRegenerate(outputPath, inputDir, currentInputFiles) {
+    const existingSource = await readFile(outputPath, "utf8");
+    if (!existingSource.startsWith(generatedKubeConfigHeader(inputDir))) {
+        return false;
+    }
+    try {
+        const existingConfig = parseKubeConfig(existingSource, outputPath);
+        const previousInputFiles = await findInputFilesRepresentedInConfig(currentInputFiles, existingConfig);
+        if (previousInputFiles.length === 0) {
+            return false;
+        }
+        const { config } = await buildMergedConfigFromFiles(previousInputFiles);
+        return existingSource === serializeGeneratedKubeConfig(config, inputDir);
+    }
+    catch {
+        return false;
+    }
+}
+async function findInputFilesRepresentedInConfig(inputFiles, config) {
+    const representedInputFiles = [];
+    for (const inputFile of inputFiles) {
+        const inputConfig = await readKubeConfigFile(inputFile);
+        if (configContainsAllNamedEntries(config, inputConfig, inputFile)) {
+            representedInputFiles.push(inputFile);
+        }
+    }
+    return representedInputFiles;
+}
+function configContainsAllNamedEntries(haystack, needle, sourceLabel) {
+    return hasAllNamedEntries(getNamedClusters(haystack, sourceLabel), getNamedClusters(needle, sourceLabel))
+        && hasAllNamedEntries(getNamedUsers(haystack, sourceLabel), getNamedUsers(needle, sourceLabel))
+        && hasAllNamedEntries(getNamedContexts(haystack, sourceLabel), getNamedContexts(needle, sourceLabel));
+}
+function hasAllNamedEntries(haystack, needles) {
+    const entriesByName = new Map(haystack.map((entry) => [entry.name, entry]));
+    return needles.every((needle) => deepEqual(entriesByName.get(needle.name), needle));
+}
+function deepEqual(left, right) {
+    return JSON.stringify(left) === JSON.stringify(right);
+}
 async function pathExists(filePath) {
     try {
         await stat(filePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubepile",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Compile and split kubeconfig files from ~/.config/kubepile.",
   "type": "module",
   "main": "./dist/src/kubepile.js",