@takodotid/circuit 0.4.3 → 0.4.7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@takodotid/circuit",
-    "version": "0.4.3",
+    "version": "0.4.7",
     "description": "Declarative, vendor-neutral network configuration: describe each device in TypeScript, and Circuit makes the device match. Alpha.",
     "keywords": [
         "network",
@@ -42,7 +42,7 @@
         ".": "./src/index.ts"
     },
     "bin": {
-        "circuit": "./src/cli/index.ts"
+        "circuit": "src/cli/index.ts"
     },
     "files": [
         "src",

package/src/adapters/devices/routeros/plan.ts

@@ -10,6 +10,8 @@ export const INSTALL_CERTIFICATE = "#install-certificate ";
 
 /** Dependency order. A menu not listed sorts after all of these. The longest matching prefix decides. */
 const ORDER = [
+    // Certificates depend on nothing, and services name them.
+    "/certificate",
     "/interface bridge",
     "/interface ethernet",
     "/interface bonding",
@@ -42,7 +44,6 @@ const ORDER = [
     "/ipv6",
     "/routing",
     "/interface ethernet switch",
-    "/certificate",
     "/snmp",
     "/tool",
     "/user",
@@ -257,7 +258,7 @@ function planEntries(menu: string, wanted: Command[], existing: Command[], sendS
 }
 
 /**
- * Certificates are installed from the config when missing or different, after the old one of that name is removed. One the config does not hold is removed in the last phase.
+ * Certificates are installed from the config when missing or different, after the old one of that name is removed. One the device holds under another name, with the same fingerprint and key, is renamed rather than imported a second time. One the config does not hold is removed in the last phase.
  */
 function planCertificates(wanted: Command[], existing: Command[]): MenuPlan {
     const menu = "/certificate";
@@ -265,19 +266,37 @@ function planCertificates(wanted: Command[], existing: Command[]): MenuPlan {
     const install: Step = { title: menu, show: [], send: [] };
     const remove: Step = { title: menu, show: [], send: [] };
     const existingByName = new Map(existing.map((item) => [item.attrs.name, item]));
+    const wantedNames = new Set(wanted.map((item) => item.attrs.name));
+    const renamed = new Set<string>();
 
     for (const entry of wanted) {
         const name = entry.attrs.name!;
         const current = existingByName.get(name);
         if (current && canonical(current) === canonical(entry)) continue;
 
+        const sameCertificate = existing.find(
+            (item) =>
+                !wantedNames.has(item.attrs.name) &&
+                !renamed.has(item.attrs.name!) &&
+                item.attrs.fingerprint === entry.attrs.fingerprint &&
+                item.attrs["private-key"] === entry.attrs["private-key"]
+        );
+
+        if (!current && sameCertificate) {
+            const oldName = sameCertificate.attrs.name!;
+            renamed.add(oldName);
+            install.show.push(`~ rename ${oldName} to ${name}`);
+            install.send.push(`${menu} set [ find name=${quote(oldName)} ] name=${quote(name)}`);
+            continue;
+        }
+
         install.show.push(`${current ? "~" : "+"} install ${name}`);
         if (current) install.send.push(`${menu} remove [ find name=${quote(name)} ]`);
         install.send.push(INSTALL_CERTIFICATE + name);
     }
 
     for (const entry of existing) {
-        if (wanted.some((candidate) => candidate.attrs.name === entry.attrs.name)) continue;
+        if (wantedNames.has(entry.attrs.name) || renamed.has(entry.attrs.name!)) continue;
 
         remove.show.push(`- ${entry.attrs.name}`);
         remove.send.push(`${menu} remove [ find name=${quote(entry.attrs.name!)} ]`);

package/src/adapters/devices/vrp/TRAPS.md

@@ -20,3 +20,4 @@ Behaviour that looks like something else. Each one has been hit on a CE6855 runn
 - `abort` is not a command here. `clear configuration candidate` discards uncommitted changes.
 - sFlow samples per port, `sflow sampling rate N`, N from 4096; the default is 8192 and an explicit 8192 is kept as written. A port names a collector only once the collector exists globally; until then it is refused with "collector does not exist".
 - `vlan batch` holds every VLAN on one line, and undoing a list that names a VLAN with an L3 interface is refused. A change sends only the VLANs added and `undo vlan batch` for the ones removed.
+- A VLAN name is unique across VLANs: a new VLAN cannot take a name another still holds. VLANs no longer used, and their VLAN interfaces, are removed first, in the same candidate.

package/src/adapters/devices/vrp/index.ts

@@ -722,21 +722,52 @@ export async function apply(device: Device, _network: readonly Device[], plan: P
     console.log("  committed, login proved, saved");
 }
 
+/**
+ * What changes, in the order the platform accepts.
+ *
+ * A VLAN list changes by ID. VLANs no longer used go first, with their VLAN interfaces, so their names and numbers are free before a new VLAN takes them: a VLAN name is unique, and a VLAN with an interface cannot be removed. The whole plan is one candidate, so going first leaves nothing half done.
+ */
+function plan(desired: string, current: string): Plan {
+    const groups = compare(desired, current, dialect);
+    vlanListChange(
+        groups,
+        "vlan batch ",
+        batchIds,
+        (ids) => [`vlan batch ${vlanBatch(ids)}`],
+        (ids) => [`vlan batch ${vlanBatch(ids)}`]
+    );
+
+    const top = groups.find((group) => group.path.length === 0);
+    const removedBatch = top?.remove.find((line) => line.startsWith("vlan batch ")) ?? "";
+    const removedIds = removedBatch ? batchIds(removedBatch) : [];
+
+    const firstRemovals = [
+        ...removedIds.map((id) => `interface Vlanif${id}`).filter((line) => top?.remove.includes(line)),
+        ...removedIds.map((id) => `vlan ${id}`).filter((line) => top?.remove.includes(line)),
+        ...(removedBatch ? [removedBatch] : []),
+    ];
+
+    if (top) top.remove = top.remove.filter((line) => !firstRemovals.includes(line));
+
+    const planned = steps(
+        groups.filter((group) => group.add.length || group.remove.length),
+        dialect
+    );
+
+    if (firstRemovals.length) {
+        // `undo vlan batch` removes a VLAN's own settings with it, so only the interfaces and the list are sent.
+        const sent = firstRemovals.filter((line) => !/^vlan \d+$/.test(line)).map(undo);
+        planned.unshift({ title: "VLANs no longer used", show: firstRemovals.map((line) => `- ${line}`), send: sent });
+    }
+
+    return { steps: planned, problems: [] };
+}
+
 export const vrp: DeviceAdapter = {
     extension: ".cfg",
     unsupported,
     render,
     read,
-    plan: (desired, current) => {
-        const groups = compare(desired, current, dialect);
-        vlanListChange(
-            groups,
-            "vlan batch ",
-            batchIds,
-            (ids) => [`vlan batch ${vlanBatch(ids)}`],
-            (ids) => [`vlan batch ${vlanBatch(ids)}`]
-        );
-        return { steps: steps(groups, dialect), problems: [] };
-    },
+    plan,
     apply,
 };