Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { frodo } from '@rockcarver/frodo-lib';

import { configManagerImportCookieDomains } from '../../../configManagerOps/FrConfigCookieDomainsOps';
import { getTokens } from '../../../ops/AuthenticateOps';
import { printMessage, verboseMessage } from '../../../utils/Console';
import { FrodoCommand } from '../../FrodoCommand';

const { CLOUD_DEPLOYMENT_TYPE_KEY, FORGEOPS_DEPLOYMENT_TYPE_KEY } =
frodo.utils.constants;

const deploymentTypes = [
CLOUD_DEPLOYMENT_TYPE_KEY,
FORGEOPS_DEPLOYMENT_TYPE_KEY,
];

export default function setup() {
const program = new FrodoCommand(
'frodo config-manager push cookie-domains',
[],
deploymentTypes
);

program
.description('Import cookie domains.')
.action(async (host, realm, user, password, options, command) => {
command.handleDefaultArgsAndOpts(
host,
realm,
user,
password,
options,
command
);

if (await getTokens(false, true, deploymentTypes)) {
verboseMessage('Importing cookie domains...');
const outcome = await configManagerImportCookieDomains();
if (!outcome) process.exitCode = 1;
}
// unrecognized combination of options or no options
else {
printMessage(
'Unrecognized combination of options or no options...',
'error'
);
program.help();
process.exitCode = 1;
}
});

return program;
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { FrodoStubCommand } from '../../FrodoCommand';
import AccessConfig from './config-manager-push-access-config';
import Audit from './config-manager-push-audit';
import CookieDomains from './config-manager-push-cookie-domain';
import EmailProvider from './config-manager-push-email-provider';
import EmailTemplates from './config-manager-push-email-templates';
import Endpoints from './config-manager-push-endpoints';
Expand Down Expand Up @@ -33,6 +34,7 @@ export default function setup() {
program.addCommand(ManagedObjects().name('managed-objects'));
program.addCommand(AccessConfig().name('access-config'));
program.addCommand(Audit().name('audit'));
program.addCommand(CookieDomains().name('cookie-domains'));

return program;
}
26 changes: 22 additions & 4 deletions src/configManagerOps/FrConfigCookieDomainsOps.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import { frodo } from '@rockcarver/frodo-lib';
import fs from 'fs';

import { printError } from '../utils/Console';

const { getFilePath, saveJsonToFile } = frodo.utils;
const { readCookieDomains } = frodo.cloud.env;
const { readCookieDomains, updateCookieDomains } = frodo.cloud.env;

/**
* Export an IDM configuration object in the fr-config-manager format.
* @param {string} envFile File that defines environment specific variables for replacement during configuration export/import
* Export cookie domains in the fr-config-manager format.
* @return {Promise<boolean>} a promise that resolves to true if successful, false otherwise
*/
export async function configManagerExportCookieDomains(): Promise<boolean> {
Expand All @@ -19,7 +20,24 @@ export async function configManagerExportCookieDomains(): Promise<boolean> {
);
return true;
} catch (error) {
printError(error, `Error exporting config entity access`);
printError(error, `Error exporting custom domains`);
}
return false;
}

/**
* Import cookie domains from fr-config-manager format.
* @return {Promise<boolean>} a promise that resolves to true if successful, false otherwise
*/
export async function configManagerImportCookieDomains(): Promise<boolean> {
try {
const getFile = getFilePath('cookie-domains/cookie-domains.json');
const readFile = fs.readFileSync(getFile, 'utf-8');
const importData = JSON.parse(readFile);
await updateCookieDomains(importData);
return true;
} catch (error) {
printError(error, `Error importing custom domains`);
}
return false;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`CLI help interface for 'config-manager push cookie-domains' should be expected english 1`] = `
"Usage: frodo config-manager push cookie-domains [options] [host] [realm] [username] [password]

[Experimental] Import cookie domains.

Arguments:
host AM base URL, e.g.: https://cdk.iam.example.com/am. To use a
connection profile, just specify a unique substring or
alias.
realm Realm. Specify realm as '/' for the root realm or 'realm' or
'/parent/child' otherwise. (default: "alpha" for Identity
Cloud tenants, "/" otherwise.)
username Username to login with. Must be an admin user with
appropriate rights to manage authentication journeys/trees.
password Password.

Options:
-h, --help Help
-hh, --help-more Help with all options.
-hhh, --help-all Help with all options, environment variables, and usage
examples.
"
`;
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Options:
Commands:
access-config [Experimental] Import access configuration.
audit [Experimental] Import audit configuration.
cookie-domains [Experimental] Import cookie domains.
email-provider [Experimental] Import email provider configuration.
email-templates [Experimental] Import email template objects.
endpoints [Experimental] Import custom endpoints objects.
Expand Down
10 changes: 10 additions & 0 deletions test/client_cli/en/config-manager-push-cookie-domains.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import cp from 'child_process';
import { promisify } from 'util';

const exec = promisify(cp.exec);
const CMD = 'frodo config-manager push cookie-domains --help';
const { stdout } = await exec(CMD);

test("CLI help interface for 'config-manager push cookie-domains' should be expected english", async () => {
expect(stdout).toMatchSnapshot();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`frodo config-manager push cookie-domains "frodo config-manager push cookie-domains -D test/e2e/exports/fr-config-manager/cloud ": should import the cookie-domains into cloud" 1`] = `""`;

exports[`frodo config-manager push cookie-domains "frodo config-manager push cookie-domains -D test/e2e/exports/fr-config-manager/cloud ": should import the cookie-domains into cloud" 2`] = `
"Experimental feature in use: 'frodo config-manager push cookie-domains'. This feature may change without notice.
"
`;
73 changes: 73 additions & 0 deletions test/e2e/config-manager-push-cookie-domains.e2e.test.js
Comment thread
dallinjsevy marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/**
* Follow this process to write e2e tests for the CLI project:
*
* 1. Test if all the necessary mocks for your tests already exist.
* In mock mode, run the command you want to test with the same arguments
* and parameters exactly as you want to test it, for example:
*
* $ FRODO_MOCK=1 frodo conn save https://openam-frodo-dev.forgeblocks.com/am volker.scheuber@forgerock.com Sup3rS3cr3t!
*
* If your command completes without errors and with the expected results,
* all the required mocks already exist and you are good to write your
* test and skip to step #4.
*
* If, however, your command fails and you see errors like the one below,
* you know you need to record the mock responses first:
*
* [Polly] [adapter:node-http] Recording for the following request is not found and `recordIfMissing` is `false`.
*
* 2. Record mock responses for your exact command.
* In mock record mode, run the command you want to test with the same arguments
* and parameters exactly as you want to test it, for example:
*
* $ FRODO_MOCK=record frodo conn save https://openam-frodo-dev.forgeblocks.com/am volker.scheuber@forgerock.com Sup3rS3cr3t!
*
* Wait until you see all the Polly instances (mock recording adapters) have
* shutdown before you try to run step #1 again.
* Messages like these indicate mock recording adapters shutting down:
*
* Polly instance 'conn/4' stopping in 3s...
* Polly instance 'conn/4' stopping in 2s...
* Polly instance 'conn/save/3' stopping in 3s...
* Polly instance 'conn/4' stopping in 1s...
* Polly instance 'conn/save/3' stopping in 2s...
* Polly instance 'conn/4' stopped.
* Polly instance 'conn/save/3' stopping in 1s...
* Polly instance 'conn/save/3' stopped.
*
* 3. Validate your freshly recorded mock responses are complete and working.
* Re-run the exact command you want to test in mock mode (see step #1).
*
* 4. Write your test.
* Make sure to use the exact command including number of arguments and params.
*
* 5. Commit both your test and your new recordings to the repository.
* Your tests are likely going to reside outside the frodo-lib project but
* the recordings must be committed to the frodo-lib project.
*/

/*
// Cloud
FRODO_MOCK=record FRODO_NO_CACHE=1 FRODO_HOST=https://openam-frodo-dev.forgeblocks.com/am frodo config-manager push cookie-domains -D test/e2e/exports/fr-config-manager/cloud
*/

import cp from 'child_process';
import { promisify } from 'util';
import { getEnv, removeAnsiEscapeCodes } from './utils/TestUtils';
import { connection as c } from './utils/TestConfig';

const exec = promisify(cp.exec);

process.env['FRODO_MOCK'] = '1';
const cloudEnv = getEnv(c);

const allDirectory = "test/e2e/exports/fr-config-manager/cloud";

describe('frodo config-manager push cookie-domains', () => {
test(`"frodo config-manager push cookie-domains -D ${allDirectory} ": should import the cookie-domains into cloud"`, async () => {
const CMD = `frodo config-manager push cookie-domains -D ${allDirectory}`;
const { stdout, stderr } = await exec(CMD, cloudEnv);
expect(removeAnsiEscapeCodes(stdout)).toMatchSnapshot();
expect(removeAnsiEscapeCodes(stderr)).toMatchSnapshot();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"domains": [
"frodo-dev.com",
"test-frodo.com"
]
}
Loading