@c8y/toolkit 1022.9.2 → 1022.10.1

package/README.md

@@ -20,6 +20,8 @@ Options:
 
 Commands:
   deploy [options] <zipFile>  Deploy application to Cumulocity
+  create-tenant [options]     Creates a new subtenant.
+  delete-tenants [options]    Deletes existing subtenants.
   help [command]              display help for command
 ```
 
@@ -52,3 +54,54 @@ Options:
 
 To e.g. deploy a previously built zip file of a plugin package, you could e.g. execute:
 `npx @c8y/toolkit deploy -u "https://demos.cumulocity.com" -U "dummyUser" -P "dummyPassword" -t "t123456" --tags "latest" --rolling-tags --add-web-sdk-stable-tag ./sample-plugin.zip`
+
+## Create tenant
+
+This cli can be used to create tenants. This might be used inside of CI workflows in order to create tenants to run tests against.
+To get all of the options available simply execute `npx @c8y/toolkit create-tenant -h`.
+This should give you and output like:
+
+```
+Usage: @c8y/toolkit create-tenant [options]
+
+Creates a new subtenant.
+
+Options:
+  -u, --url <URL>                       The url of the remote instance. Can also be passed via the "C8Y_URL" environment variable.
+  -U, --user <user>                     Username of the Cumulocity instance. Can also be passed via the "C8Y_USER" environment variable.
+  -P, --password <password>             Password of the Cumulocity instance. Can also be passed via the "C8Y_PASSWORD" environment variable.
+  -t, --tenant <tenant>                 Tenant of the Cumulocity instance. Can also be passed via the "C8Y_TENANT" environment variable.
+  --tenantsNumber <n>                   The number of tenants to be created, default to 1.
+  --tenantUser [value]                  Username of the created tenant(s).
+  --tenantPassword [value]              Password of the created tenant(s).
+  --domainNamePrefix [value]            The tenant name value
+  --allowCreateTenants [value]          If the created tenant(s) should be allowed to create subtenants (default: true)
+  --companyName [value]                 A scope is added as the company name (default: "e2eTesting tenant")
+  --noTenantSuffix [value]              If set to true, there will be no number attached to the tenant name (default: false)
+  --contactName [value]                 The tenants contact name. (default: "Mr. Smith")
+  --contactPhone [value]                The tenants contact phone. (default: "+48123456789")
+  --applicationsToBeSubscribed [value]  A comma separated list of applications names to be subscribed (default: "")
+  -h, --help                            display help for command
+```
+
+## Delete tenants
+
+This cli can be used to delete tenants. This might be used inside of CI workflows in order to delete tenants that have been previously used to run tests against.
+To get all of the options available simply execute `npx @c8y/toolkit delete-tenants -h`.
+This should give you and output like:
+
+```
+Usage: @c8y/toolkit delete-tenants [options]
+
+Deletes existing subtenants.
+
+Options:
+  -u, --url <URL>            The url of the remote instance. Can also be passed via the "C8Y_URL" environment variable.
+  -U, --user <user>          Username of the Cumulocity instance. Can also be passed via the "C8Y_USER" environment variable.
+  -P, --password <password>  Password of the Cumulocity instance. Can also be passed via the "C8Y_PASSWORD" environment variable.
+  -t, --tenant <tenant>      Tenant of the Cumulocity instance. Can also be passed via the "C8Y_TENANT" environment variable.
+  -a, --age <age>            The age of the tenant in hours since it's creation time
+  --companyName <value>      A scope is added as the company name. All tenants where the company name includes the provided string, will be deleted. (default: "e2eTesting tenant")
+  --includeChildren          If set, all subtenants will be deleted as well
+  -h, --help                 display help for command
+```

package/dist/cli.js

@@ -5,9 +5,11 @@ const commander_1 = require("commander");
 const deploy_1 = require("./commands/deploy");
 const package_json_1 = require("./../package.json");
 const create_tenant_1 = require("./commands/create-tenant");
+const delete_tenants_1 = require("./commands/delete-tenants");
 const program = new commander_1.Command();
 program.name(package_json_1.name).description(package_json_1.description).version(package_json_1.version);
 (0, deploy_1.registerDeployCommand)(program);
 (0, create_tenant_1.registerCreateTenantCommand)(program);
+(0, delete_tenants_1.registerDeleteTenantsCommand)(program);
 program.parseAsync(process.argv);
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,8CAA0D;AAC1D,oDAA+D;AAC/D,4DAAuE;AAEvE,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAC9B,OAAO,CAAC,IAAI,CAAC,mBAAI,CAAC,CAAC,WAAW,CAAC,0BAAW,CAAC,CAAC,OAAO,CAAC,sBAAO,CAAC,CAAC;AAC7D,IAAA,8BAAqB,EAAC,OAAO,CAAC,CAAC;AAC/B,IAAA,2CAA2B,EAAC,OAAO,CAAC,CAAC;AAErC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,8CAA0D;AAC1D,oDAA+D;AAC/D,4DAAuE;AACvE,8DAAyE;AAEzE,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAC9B,OAAO,CAAC,IAAI,CAAC,mBAAI,CAAC,CAAC,WAAW,CAAC,0BAAW,CAAC,CAAC,OAAO,CAAC,sBAAO,CAAC,CAAC;AAC7D,IAAA,8BAAqB,EAAC,OAAO,CAAC,CAAC;AAC/B,IAAA,2CAA2B,EAAC,OAAO,CAAC,CAAC;AACrC,IAAA,6CAA4B,EAAC,OAAO,CAAC,CAAC;AAEtC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/commands/delete-tenants.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function registerDeleteTenantsCommand(program: Command): void;

package/dist/commands/delete-tenants.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerDeleteTenantsCommand = registerDeleteTenantsCommand;
+const constants_1 = require("../constants");
+const helpers_1 = require("../utils/helpers");
+const delete_tenants_1 = require("../utils/delete-tenants");
+function registerDeleteTenantsCommand(program) {
+    program
+        .command('delete-tenants')
+        .description('Deletes existing subtenants.')
+        .requiredOption('-u, --url <URL>', constants_1.OPTIONS_CONSTANTS['TXT.URL'], (0, helpers_1.getFromEnvVar)('C8Y_URL'))
+        .requiredOption('-U, --user <user>', constants_1.OPTIONS_CONSTANTS['TXT.USERNAME'], (0, helpers_1.getFromEnvVar)('C8Y_USER'))
+        .requiredOption('-P, --password <password>', constants_1.OPTIONS_CONSTANTS['TXT.PASSWORD'], (0, helpers_1.getFromEnvVar)('C8Y_PASSWORD'))
+        .option('-t, --tenant <tenant>', constants_1.OPTIONS_CONSTANTS['TXT.TENANT'], (0, helpers_1.getFromEnvVar)('C8Y_TENANT'))
+        .option('-a, --age <age>', "The age of the tenant in hours since it's creation time", parseInt)
+        .requiredOption('--companyName <value>', 'A scope is added as the company name. All tenants where the company name includes the provided string, will be deleted.', 'e2eTesting tenant')
+        .option('--includeChildren', 'If set, all subtenants will be deleted as well')
+        .action(async (options) => {
+        try {
+            await (0, delete_tenants_1.deleteTenants)(options);
+        }
+        catch (e) {
+            console.error('Failed to delete tenants');
+            console.error(e);
+            throw e;
+        }
+    });
+}
+//# sourceMappingURL=delete-tenants.js.map

package/dist/commands/delete-tenants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-tenants.js","sourceRoot":"","sources":["../../src/commands/delete-tenants.ts"],"names":[],"mappings":";;AAKA,oEAiCC;AArCD,4CAAiD;AACjD,8CAAiD;AACjD,4DAAwD;AAExD,SAAgB,4BAA4B,CAAC,OAAgB;IAC3D,OAAO;SACJ,OAAO,CAAC,gBAAgB,CAAC;SACzB,WAAW,CAAC,8BAA8B,CAAC;SAC3C,cAAc,CAAC,iBAAiB,EAAE,6BAAiB,CAAC,SAAS,CAAC,EAAE,IAAA,uBAAa,EAAC,SAAS,CAAC,CAAC;SACzF,cAAc,CACb,mBAAmB,EACnB,6BAAiB,CAAC,cAAc,CAAC,EACjC,IAAA,uBAAa,EAAC,UAAU,CAAC,CAC1B;SACA,cAAc,CACb,2BAA2B,EAC3B,6BAAiB,CAAC,cAAc,CAAC,EACjC,IAAA,uBAAa,EAAC,cAAc,CAAC,CAC9B;SACA,MAAM,CAAC,uBAAuB,EAAE,6BAAiB,CAAC,YAAY,CAAC,EAAE,IAAA,uBAAa,EAAC,YAAY,CAAC,CAAC;SAC7F,MAAM,CAAC,iBAAiB,EAAE,yDAAyD,EAAE,QAAQ,CAAC;SAC9F,cAAc,CACb,uBAAuB,EACvB,yHAAyH,EACzH,mBAAmB,CACpB;SACA,MAAM,CAAC,mBAAmB,EAAE,gDAAgD,CAAC;SAE7E,MAAM,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;QACtB,IAAI,CAAC;YACH,MAAM,IAAA,8BAAa,EAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/utils/delete-tenants.d.ts

@@ -0,0 +1,9 @@
+export declare function deleteTenants(options: {
+    user: string;
+    password: string;
+    url: string;
+    tenant?: string;
+    age?: number;
+    companyName: string;
+    includeChildren?: boolean;
+}): Promise<void>;

package/dist/utils/delete-tenants.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteTenants = deleteTenants;
+const client_1 = require("./client");
+const chalk_1 = __importDefault(require("chalk"));
+async function deleteTenants(options) {
+    const { user, password, url, tenant } = options;
+    const client = await (0, client_1.createClient)({ user, password, url, tenant });
+    console.log(chalk_1.default.green('Provided credentials are valid.'));
+    const { data: allTenants } = await client.tenant.list({
+        pageSize: 2000,
+        withApps: false,
+        withParents: true
+    });
+    const { companyName, age, includeChildren } = options;
+    const tenantsWithMatchingCompany = allTenants.filter((t) => {
+        return t.company && t.company.includes(companyName);
+    });
+    const milisecondsAgeOffset = age ? age * 60 * 60 * 1000 : 0;
+    const minimumAge = new Date(Date.now() - milisecondsAgeOffset);
+    const tenantsWithCorrectAge = tenantsWithMatchingCompany.filter((t) => {
+        return t.creationTime && new Date(t.creationTime) < minimumAge;
+    });
+    console.log(chalk_1.default.blue(`Found ${tenantsWithCorrectAge.length} tenants where the company name includes "${companyName}" and which are older than "${minimumAge.toISOString()}"`));
+    const childTenantsToRemove = [];
+    if (includeChildren) {
+        for (const tenant of tenantsWithCorrectAge) {
+            const tenantsWhereParentMatches = allTenants.filter(t => t.parent === tenant.id);
+            childTenantsToRemove.push(...tenantsWhereParentMatches);
+        }
+        console.log(chalk_1.default.blue(`Including ${childTenantsToRemove.length} child tenants for deletion...`));
+    }
+    const allTenantsToDelete = [...childTenantsToRemove, ...tenantsWithCorrectAge];
+    let deletionFailures = 0;
+    for (const tenant of allTenantsToDelete) {
+        console.log(chalk_1.default.blue(`Deleting tenant ${tenant.domain} (${tenant.id})...`));
+        try {
+            await client.tenant.delete(tenant.id);
+            console.log(chalk_1.default.green(`Tenant ${tenant.domain} (${tenant.id}) deleted successfully.`));
+        }
+        catch (e) {
+            console.error(chalk_1.default.red(`Failed to delete tenant ${tenant.domain} (${tenant.id}):`), e);
+            deletionFailures++;
+        }
+    }
+    if (deletionFailures > 0) {
+        console.error(chalk_1.default.red(`Failed to delete ${deletionFailures} tenants.`));
+        throw new Error('Some tenants could not be deleted.');
+    }
+    else {
+        console.log(chalk_1.default.green('All specified tenants deleted successfully.'));
+    }
+}
+//# sourceMappingURL=delete-tenants.js.map

package/dist/utils/delete-tenants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-tenants.js","sourceRoot":"","sources":["../../src/utils/delete-tenants.ts"],"names":[],"mappings":";;;;;AAIA,sCAqEC;AAxED,qCAAwC;AACxC,kDAA0B;AAEnB,KAAK,UAAU,aAAa,CAAC,OAQnC;IACC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEhD,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAY,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;IAE5D,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;QACpD,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,KAAK;QACf,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IACtD,MAAM,0BAA0B,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAU,EAAE,EAAE;QAClE,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,oBAAoB,CAAC,CAAC;IAC/D,MAAM,qBAAqB,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAU,EAAE,EAAE;QAC7E,OAAO,CAAC,CAAC,YAAY,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,IAAI,CACR,SAAS,qBAAqB,CAAC,MAAM,6CAA6C,WAAW,+BAA+B,UAAU,CAAC,WAAW,EAAE,GAAG,CACxJ,CACF,CAAC;IAEF,MAAM,oBAAoB,GAAc,EAAE,CAAC;IAC3C,IAAI,eAAe,EAAE,CAAC;QACpB,KAAK,MAAM,MAAM,IAAI,qBAAqB,EAAE,CAAC;YAC3C,MAAM,yBAAyB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;YACjF,oBAAoB,CAAC,IAAI,CAAC,GAAG,yBAAyB,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,IAAI,CAAC,aAAa,oBAAoB,CAAC,MAAM,gCAAgC,CAAC,CACrF,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,GAAG,CAAC,GAAG,oBAAoB,EAAE,GAAG,qBAAqB,CAAC,CAAC;IAE/E,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,KAAK,MAAM,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,mBAAmB,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAE9E,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAY,CAAC,CAAC;YAChD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,2BAA2B,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACxF,gBAAgB,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,oBAAoB,gBAAgB,WAAW,CAAC,CAAC,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c8y/toolkit",
-  "version": "1022.9.2",
+  "version": "1022.10.1",
   "license": "Apache-2.0",
   "author": "Cumulocity GmbH",
   "description": "Toolkit for Cumulocity applications, allows to e.g. deploy an application to an instance of Cumulocity.",
@@ -18,7 +18,7 @@
     "m2m"
   ],
   "dependencies": {
-    "@c8y/client": "1022.9.2",
+    "@c8y/client": "1022.10.1",
     "chalk": "^4.1.2",
     "commander": "13.1.0",
     "lodash": "4.17.21",