@voxgig/sdkgen 4.33.0 → 4.34.1

package/project/.sdk/src/cmp/java/PrepareAuth_java.ts

@@ -84,10 +84,7 @@ final class PrepareAuth {
       'import java.nio.charset.StandardCharsets;',
       'import java.util.Base64;',
     ] : []),
-    // `List.of("auth", "prefix")` is the only use of java.util.List, and a
-    // prefix is a HEADER convention — the query and cookie branches drop it,
-    // so neither needs the import.
-    ...(header ? ['import java.util.List;'] : []),
+    'import java.util.List;',
     'import java.util.Map;',
   ].join('\n')
 
@@ -113,7 +110,7 @@ final class PrepareAuth {
           || NOT_FOUND.equals(secret) || "".equals(secret);
 
       if (noApikey) {
-        headers.remove(CRED_NAME);
+        headers.remove(name);
       }
       else {
         String basicPrefix = "";
@@ -127,10 +124,10 @@ final class PrepareAuth {
         // registration covers.
         ctx.utility.cleanAdd.apply(ctx, b64);
         if ("".equals(basicPrefix)) {
-          headers.put(CRED_NAME, b64);
+          headers.put(name, b64);
         }
         else {
-          headers.put(CRED_NAME, basicPrefix + " " + b64);
+          headers.put(name, basicPrefix + " " + b64);
         }
       }
 
@@ -152,6 +149,13 @@ final class PrepareAuth {
 
 ${consts}
 
+  // The client's auth.name option, when set, replaces the name the API declares.
+  static String authName(Map<String, Object> options) {
+    Object name = Struct.getpath(options, List.of("auth", "name"));
+    return name instanceof String && !"".equals(name)
+        ? ${header ? '((String) name).toLowerCase(java.util.Locale.ROOT)' : '(String) name'} : CRED_NAME;
+  }
+${cookie ? COOKIE_HELPER : ''}
   static Spec prepareAuth(Context ctx) {
     Spec spec = ctx.spec;
     if (spec == null) {
@@ -164,10 +168,17 @@ ${consts}
 
     // Public APIs that need no auth omit the options.auth block entirely.
     if (options.get("auth") == null) {
-      ${clear(spec.where)}
+      ${clear(spec.where, 'CRED_NAME')}
       return spec;
     }
 
+    String name = authName(options);
+
+    // A credential left under the declared name would travel beside the renamed one.
+    if (!name.equals(CRED_NAME)) {
+      ${clear(spec.where, 'CRED_NAME')}
+    }
+
     Object apikey = Struct.getprop(options, OPTION_APIKEY, NOT_FOUND);
 ${basicBlock}
     boolean skip = false;
@@ -180,10 +191,10 @@ ${basicBlock}
     }
 
     if (skip) {
-      ${clear(spec.where)}
+      ${clear(spec.where, 'name')}
     }
     else {
-${place(spec.where)}
+${place(spec.where, 'name')}
     }
 
     return spec;
@@ -198,28 +209,52 @@ function credName(where: string, name: string): string {
 }
 
 
-function clear(where: string): string {
-  return 'query' === where ? 'query.remove(CRED_NAME);' : 'headers.remove(CRED_NAME);'
+// A cookie has no header of its own: place() writes it into `cookie` as
+// `name=value`, so clear() frees that pair, not a header of that name.
+function clear(where: string, name: string): string {
+  if ('cookie' === where) {
+    return `applyCookie(headers, ${name}, null);`
+  }
+  return 'query' === where ? `query.remove(${name});` : `headers.remove(${name});`
 }
 
 
-function place(where: string): string {
+// The cookie header is shared with whatever cookies the caller set, so the
+// credential's pair is spliced in and out rather than appended.
+const COOKIE_HELPER = `
+  // Rewrites the cookie header with the named pair removed, then set to the
+  // value when it is not null; every other cookie is kept in order.
+  static void applyCookie(Map<String, Object> headers, String name, String value) {
+    Object existing = headers.get(COOKIE_HEADER);
+    String cookie = existing instanceof String ? (String) existing : "";
+    List<String> kept = PrepareHeaders.cookieKeep(cookie, List.of(name));
+    if (value != null) {
+      kept.add(name + "=" + value);
+    }
+    if (kept.isEmpty()) {
+      headers.remove(COOKIE_HEADER);
+    }
+    else {
+      headers.put(COOKIE_HEADER, String.join("; ", kept));
+    }
+  }
+`
+
+
+function place(where: string, name: string): string {
   if ('query' === where) {
     return `      String apikeyVal = apikey instanceof String ? (String) apikey : "";
       // NO PREFIX IN A QUERY STRING: ?name=Bearer%20abc is not a thing any
       // API reads, so the auth.prefix option is dropped here deliberately.
-      query.put(CRED_NAME, apikeyVal);`
+      query.put(${name}, apikeyVal);`
   }
 
   if ('cookie' === where) {
     return `      String apikeyVal = apikey instanceof String ? (String) apikey : "";
-      // A cookie IS a header, but the request may already carry others, so
-      // the pair is APPENDED rather than replacing the whole cookie header.
-      // No prefix, for the same reason a query parameter carries none.
-      Object existing = Struct.getprop(headers, COOKIE_HEADER, "");
-      String cookie = existing instanceof String ? (String) existing : "";
-      String pair = CRED_NAME + "=" + apikeyVal;
-      headers.put(COOKIE_HEADER, "".equals(cookie) ? pair : cookie + "; " + pair);`
+      // Spliced in, replacing an earlier pair of the same name, beside any
+      // cookie the caller set. No prefix, for the same reason a query
+      // parameter carries none.
+      applyCookie(headers, ${name}, apikeyVal);`
   }
 
   return `      String authPrefix = "";
@@ -230,10 +265,10 @@ function place(where: string): string {
       String apikeyVal = apikey instanceof String ? (String) apikey : "";
       // Empty prefix (raw apiKey credential) must not add a leading space.
       if ("".equals(authPrefix)) {
-        headers.put(CRED_NAME, apikeyVal);
+        headers.put(${name}, apikeyVal);
       }
       else {
-        headers.put(CRED_NAME, authPrefix + " " + apikeyVal);
+        headers.put(${name}, authPrefix + " " + apikeyVal);
       }`
 }
 

package/project/.sdk/src/cmp/java/ReadmeEntity_java.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, canonKey, canonScalarKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, canonScalarKey, entityIdField, opRequestShape, opNeedsAction } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -30,6 +30,7 @@ const OP_DESC: Record<string, { method: string, desc: string }> = {
   list:   { method: 'list(null, null)',    desc: 'List entities, optionally matching the given criteria.' },
   create: { method: 'create(data, null)',  desc: 'Create a new entity with the given data.' },
   update: { method: 'update(data, null)',  desc: 'Update an existing entity.' },
+  patch:  { method: 'patch(data, null)',   desc: 'Change part of an existing entity.' },
   remove: { method: 'remove(match, null)', desc: 'Remove the matching entity.' },
 }
 
@@ -55,6 +56,8 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 
   publishedEntities.map((entity: any) => {
     const opnames = Object.keys(entity.op || {})
+    // An op that needs an action has no plain call to show.
+    const callable = opnames.filter((o: string) => !opNeedsAction(entity.op[o]))
     const fields = Object.values(entity.fields || {})
     const idF = entityIdField(entity)
     // Sanitise the local variable name — a camelCased Java keyword gets a
@@ -112,7 +115,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 `)
     }
 
-    if (opnames.includes('load')) {
+    if (callable.includes('load')) {
       // The id key plus every REQUIRED match key (parent path params like
       // page_id) — the same shape the runtime resolves path params from, so
       // the example always works.
@@ -134,7 +137,7 @@ Object ${eVar} = client.${accessor}(null).load(${loadArg}, null);
 `)
     }
 
-    if (opnames.includes('list')) {
+    if (callable.includes('list')) {
       Content(`#### Example: List
 
 \`\`\`java
@@ -144,7 +147,7 @@ Object ${eVar}List = client.${accessor}(null).list(null, null);
 `)
     }
 
-    if (opnames.includes('create')) {
+    if (callable.includes('create')) {
       // Members come from the SAME shape the runtime validates
       // (opRequestShape): every required member must appear — including a
       // required id and parent keys like page_id — with a real literal.

package/project/.sdk/src/cmp/java/ReadmeHowto_java.ts

@@ -39,7 +39,7 @@ const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   let testArg = 'null'
   if (exampleEntity && isMatchOp) {
     testArg = idF ? `Map.of("${idF}", "test01")` : 'null'
-  } else if (exampleEntity && ('create' === primaryOp || 'update' === primaryOp)) {
+  } else if (exampleEntity && ('create' === primaryOp || 'update' === primaryOp || 'patch' === primaryOp)) {
     const items = opRequestShape(exampleEntity, primaryOp).items
       .filter((it: any) => it.name !== idF && it.name !== 'id')
     const required = items.filter((it: any) => !it.optional)

package/project/.sdk/src/cmp/java/ReadmeInstall_java.ts

@@ -34,9 +34,9 @@ cd java && mvn install
 
   // Publish pending: not yet on Maven Central. Install from the git release
   // tag or from a local source checkout built with Maven.
-  const { releasesUrl } = repoInfo(model)
-  Content(`This package is not yet published to Maven Central. Install it from the GitHub
-release tag (\`${target.name}/vX.Y.Z\`, see [Releases](${releasesUrl})) or
+  const { hostName, tagsUrl } = repoInfo(model)
+  Content(`This package is not yet published to Maven Central. Install it from the ${hostName}
+release tag (\`${target.name}/vX.Y.Z\`, see [Tags](${tagsUrl})) or
 from a source checkout — build the library with Maven:
 
 \`\`\`bash

package/project/.sdk/src/cmp/java/ReadmeIntro_java.ts

@@ -1,5 +1,5 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, modelText } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -11,7 +11,7 @@ import { javaVarName } from './utility_java'
 
 const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
   const { target, ctx$: { model } } = props
-  const info = (model.main && model.main.kit && model.main.kit.info) || {}
+  const info = modelText(model)
   const tagline = info.tagline || ''
 
   Content(`# ${model.Name} ${target.title} SDK
@@ -36,7 +36,7 @@ The ${target.title} SDK for the ${model.Name} API — an entity-oriented client
   // Model-driven op list — only the operations the active entities actually
   // expose (a read-only entity has just list+load); never claim
   // create/update/remove exist when no entity has them.
-  const CANON_OPS = ['list', 'load', 'create', 'update', 'remove']
+  const CANON_OPS = ['list', 'load', 'create', 'update', 'patch', 'remove']
   const opSet = new Set<string>()
   Object.values(entity || {}).forEach((e: any) => {
     if (!e || e.active === false) return

package/project/.sdk/src/cmp/java/ReadmeModel_java.ts

@@ -28,9 +28,10 @@ const ReadmeModel = cmp(function ReadmeModel(props: any) {
     list: '| `list` | `(reqmatch, ctrl) -> Object` | List entities matching the criteria (an aggregate list). Raises on error. |',
     create: '| `create` | `(reqdata, ctrl) -> Object` | Create a new entity. Raises on error. |',
     update: '| `update` | `(reqdata, ctrl) -> Object` | Update an existing entity. Raises on error. |',
+    patch: '| `patch` | `(reqdata, ctrl) -> Object` | Change part of an existing entity. Raises on error. |',
     remove: '| `remove` | `(reqmatch, ctrl) -> Object` | Remove an entity. Raises on error. |',
   }
-  const opRows = ['load', 'list', 'create', 'update', 'remove']
+  const opRows = ['load', 'list', 'create', 'update', 'patch', 'remove']
     .filter((o) => opUnion.has(o)).map((o) => opRowDefs[o]).join('\n')
 
   const apikeyOptionRow = isAuthActive(model)

package/project/.sdk/src/cmp/java/ReadmeQuick_java.ts

@@ -196,7 +196,8 @@ catch (RuntimeException err) {
       return it && it.type
     }
 
-    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('patch') ||
+      opnames.includes('remove')) {
       Content(`### 4. Create, update, and remove
 
 \`\`\`java
@@ -213,6 +214,14 @@ Object created = client.${accessor}(null).create(Map.of(${examplePairs('create')
         Content(`// Update — supply the id in the match/data
 client.${accessor}(null).update(Map.of(${updatePairs.join(', ')}), null);
 
+`)
+      }
+      if (opnames.includes('patch')) {
+        const patchPairs = (idF ? [`"${idF}", ${javaLit(idParamType('patch'), 'example_id')}`] : [])
+          .concat(examplePairs('patch'))
+        Content(`// Patch — sends only the fields given
+client.${accessor}(null).patch(Map.of(${patchPairs.join(', ')}), null);
+
 `)
       }
       if (opnames.includes('remove')) {

package/project/.sdk/src/cmp/java/ReadmeRef_java.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonToType, canonKey, canonScalarKey, File, isAuthActive, entityIdField, opRequestShape , targetFeatures } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, canonKey, canonScalarKey, File, isAuthActive, entityIdField, opRequestShape , targetFeatures, opNeedsAction, bodyNote } from '@voxgig/sdkgen'
 import { ReadmeRefFeatures } from '@voxgig/sdkgen'
 
 import {
@@ -45,6 +45,11 @@ const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string
     returns: 'the updated entity data',
     desc: 'Update an existing entity. The data must include the entity `id`. Returns the updated entity data and raises on error.',
   },
+  patch: {
+    sig: 'patch(reqdata, ctrl) -> Object',
+    returns: 'the patched entity data',
+    desc: 'Change part of an existing entity: only the fields given are sent. The data must include the entity `id`. Returns the patched entity data and raises on error.',
+  },
   remove: {
     sig: 'remove(reqmatch, ctrl) -> Object',
     returns: 'the removed entity data',
@@ -217,7 +222,7 @@ SdkEntity ${eVar} = client.${accessor}(null);
         // Field operations breakdown
         const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
         if (hasFieldOps) {
-          const opcols = ['load', 'list', 'create', 'update', 'remove']
+          const opcols = ['load', 'list', 'create', 'update', 'patch', 'remove']
             .filter((op: string) => opnames.includes(op) && ent.op[op]?.active !== false)
           Content(`### Field Usage by Operation
 
@@ -258,6 +263,10 @@ ${info.desc}
 
 `)
 
+          if (opNeedsAction(ent.op[opname])) {
+            return
+          }
+
           if ('load' === opname || 'remove' === opname) {
             const matchItems = opRequestShape(ent, opname).items
               .filter((it: any) => !it.optional || it.name === idF)
@@ -298,8 +307,8 @@ Object result = client.${accessor}(null).create(Map.of(
 
 `)
           }
-          else if ('update' === opname) {
-            const updateItems = opRequestShape(ent, 'update').items
+          else if ('update' === opname || 'patch' === opname) {
+            const updateItems = opRequestShape(ent, opname).items
               .filter((it: any) => !it.optional || it.name === idF)
               .sort((a: any, b: any) =>
                 (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
@@ -309,12 +318,20 @@ Object result = client.${accessor}(null).create(Map.of(
                 it.name === idF ? ent.name + '_id' : it.name)}${comma}\n`
             }).join('')
             Content(`\`\`\`java
-Object result = client.${accessor}(null).update(Map.of(
+Object result = client.${accessor}(null).${opname}(Map.of(
 ${updateLines}), null);
 \`\`\`
 
 `)
           }
+
+          if ('create' === opname || 'update' === opname || 'patch' === opname) {
+            const note = bodyNote(ent.op[opname], {
+              values: 'a `byte[]`, a `String` or an `InputStream`',
+              once: 'an `InputStream`',
+            })
+            if ('' !== note) Content(note)
+          }
         })
       }
 

package/project/.sdk/src/cmp/java/ReadmeTopTest_java.ts

@@ -51,7 +51,7 @@ ${SDK} client = ${SDK}.testSDK(null, null);
         ? `Map.of(${items.map((it: any) =>
           `"${it.name}", ${it.name === idF ? '"test01"' : javaLit(it.type)}`).join(', ')})`
         : 'null'
-    } else if ('create' === primaryOp || 'update' === primaryOp) {
+    } else if ('create' === primaryOp || 'update' === primaryOp || 'patch' === primaryOp) {
       const items = opRequestShape(exampleEntity, primaryOp).items
         .filter((it: any) => it.name !== idF && it.name !== 'id')
       const required = items.filter((it: any) => !it.optional)

package/project/.sdk/src/cmp/java/TestClean_java.ts

@@ -435,8 +435,34 @@ public class CleanTest {
           },
           "body", "<html>")));
 
+  // Offline, as every generated suite is: the test OPTION resolves a
+  // required server variable to test-<name>, and installs no transport.
+  static Map<String, Object> offline(Map<String, Object> opts) {
+    Map<String, Object> out = new LinkedHashMap<>(opts);
+    out.put("test", jm("active", true));
+    return out;
+  }
+
+  // A client the sweep cannot build leaves nothing swept: a harness error,
+  // not a leak.
+  static ${sdk} construct(Map<String, Object> opts) {
+    try {
+      return new ${sdk}(offline(opts));
+    }
+    catch (RuntimeException e) {
+      throw new IllegalStateException(
+          "clean harness: the client could not be constructed, so nothing was swept: "
+          + e.getMessage(), e);
+    }
+  }
+
   static ${sdk} makeSdk(Scenario scenario, List<Sink> sinks, Map<String, Object> cleanopts,
       BaseFeature... extra) {
+    return construct(makeOpts(scenario, sinks, cleanopts, extra));
+  }
+
+  static Map<String, Object> makeOpts(Scenario scenario, List<Sink> sinks,
+      Map<String, Object> cleanopts, BaseFeature... extra) {
     Map<String, Object> feature = new LinkedHashMap<>();
     if (hasFeature("log")) {
       feature.put("log", jm("active", true));
@@ -477,7 +503,7 @@ public class CleanTest {
         "feature", feature,
         "extend", extend,
         "utility", jm("fetcher", scenario.respond));
-    return new ${sdk}(opts);
+    return opts;
   }
 
   // Every log line the log feature emits, whichever level it chooses.
@@ -518,7 +544,10 @@ public class CleanTest {
   }
 
   static Object invoke(${sdk} client, Op op, Map<String, Object> ctrl) throws Exception {
-    Object ent = op.accessor.invoke(client, new Object[] {null});
+    return invokeOn(op.accessor.invoke(client, new Object[] {null}), op, ctrl);
+  }
+
+  static Object invokeOn(Object ent, Op op, Map<String, Object> ctrl) throws Exception {
     try {
       return op.call.invoke(ent, new LinkedHashMap<String, Object>(op.match), ctrl);
     }
@@ -560,7 +589,7 @@ public class CleanTest {
     Map<String, Object> plainOpts = jm("apikey", CANARY_APIKEY, "utility", jm("fetcher", ok));
 
     Map<String, Method> accessors = new TreeMap<>();
-    ${sdk} probe = new ${sdk}(plainOpts);
+    ${sdk} probe = construct(plainOpts);
     for (Method m : probe.getClass().getMethods()) {
       if (1 != m.getParameterCount() || !Map.class.isAssignableFrom(m.getParameterTypes()[0])) {
         continue;
@@ -588,7 +617,7 @@ public class CleanTest {
       catch (Exception ex) {
         continue;
       }
-      for (String opname : List.of("list", "load", "create", "update", "remove")) {
+      for (String opname : List.of("list", "load", "create", "update", "patch", "remove")) {
         Method call;
         try {
           call = ent.getClass().getMethod(opname, Map.class, Map.class);
@@ -601,7 +630,7 @@ public class CleanTest {
         for (Map<String, Object> match : matches) {
           Op op = new Op(e.getValue(), call, match);
           try {
-            invoke(new ${sdk}(plainOpts), op, new LinkedHashMap<>());
+            invoke(construct(plainOpts), op, new LinkedHashMap<>());
             return op;
           }
           catch (Exception ex) {
@@ -626,10 +655,12 @@ public class CleanTest {
   static Exception drive(${sdk} sdk, Op op, Map<String, Object> ctrl, List<Sink> sinks) {
     // A caller may keep the record it passed rather than read ctrl's entry.
     Object held = ctrl.get("explain");
+    Object ent = null;
     Object out = null;
     Exception err = null;
     try {
-      out = invoke(sdk, op, ctrl);
+      ent = op.accessor.invoke(sdk, new Object[] {null});
+      out = invokeOn(ent, op, ctrl);
     }
     catch (Exception e) {
       err = e;
@@ -640,6 +671,10 @@ public class CleanTest {
     if (out != null) {
       forms(sinks, "result", out);
     }
+    // Raw, as a caller copying the match into another query reads it.
+    if (ent instanceof Entity) {
+      forms(sinks, "match", ((Entity) ent).match());
+    }
     if (ctrl.get("explain") != null) {
       forms(sinks, "explain", ctrl.get("explain"));
     }
@@ -683,8 +718,14 @@ public class CleanTest {
         }
       }
 
+      // A name given at run time replaces the declared one: the match leaves
+      // out whichever name prepareAuth placed.
+      Map<String, Object> renamed = makeOpts(SCENARIOS.get(0), sinks, null);
+      renamed.put("auth", jm("name", "zzcred"));
+      drive(construct(renamed), op, new LinkedHashMap<>(), sinks);
+
       // No clean option at all: the schema defaults still apply.
-      ${sdk} bare = new ${sdk}(jm(
+      ${sdk} bare = construct(jm(
           "apikey", CANARY_APIKEY,
           "secret", CANARY_SECRET,
           "headers", jm("X-Custom-Token", CANARY_HEADER),
@@ -696,8 +737,8 @@ public class CleanTest {
       // is no rejection to sweep: sweep the client, and what clean makes of
       // the value should anything quote it.
       try {
-        ${sdk} mistyped = new ${sdk}(jm(
-            "apikey", jm("value", CANARY_APIKEY), "clean", jm("values", CANARY_VALUE)));
+        ${sdk} mistyped = new ${sdk}(offline(jm(
+            "apikey", jm("value", CANARY_APIKEY), "clean", jm("values", CANARY_VALUE))));
         forms(sinks, "mistyped", mistyped);
         forms(sinks, "mistyped:quoted", mistyped.getUtility().clean.apply(
             mistyped.getRootCtx(), "found map: " + CANARY_APIKEY));
@@ -707,7 +748,7 @@ public class CleanTest {
       }
 
       // A number is registered as the text a message quotes it in.
-      ${sdk} numeric = new ${sdk}(jm("apikey", 918273645));
+      ${sdk} numeric = construct(jm("apikey", 918273645));
       numbered = numeric.getUtility().clean.apply(numeric.getRootCtx(), "found 918273645");
 
       for (boolean unexpected : new boolean[] {false, true}) {
@@ -839,13 +880,15 @@ public class CleanTest {
   }
 
   // An entity block, of per-entity settings or seeded records keyed by
-  // entity name and id, is not read at all.
+  // entity name and id, is not read at all, and nor are rbac's rules, keyed by
+  // entity and operation names.
   @Test
   public void aFeatureNameDoesNotMakeItsSettingsSecret() {
-    ${sdk} sdk = new ${sdk}(jm(
+    ${sdk} sdk = construct(jm(
         "apikey", CANARY_APIKEY,
         "feature", jm(
             "secrets", jm("active", false, "kind", "SETTING-KIND-4829", "token", CANARY_SECRET),
+            "rbac", jm("active", false, "rules", jm("zztoken.load", "PLAINRULE-k7j5h3g1")),
             "test", jm("active", false, "entity",
                 jm("zztoken", jm("ZZTOKEN01", jm("note", "PLAINRECORD-t5r3e1w9"))))),
         "entity", jm("zztoken", jm("alias", jm("zzkey", "PLAINALIAS-m2n4b6v8")))));
@@ -856,6 +899,8 @@ public class CleanTest {
         sdk.getUtility().clean.apply(root, "record PLAINRECORD-t5r3e1w9"));
     assertEquals("alias PLAINALIAS-m2n4b6v8",
         sdk.getUtility().clean.apply(root, "alias PLAINALIAS-m2n4b6v8"));
+    assertEquals("rule PLAINRULE-k7j5h3g1",
+        sdk.getUtility().clean.apply(root, "rule PLAINRULE-k7j5h3g1"));
   }
 
   @Test