neonctl 1.29.1 → 1.29.3

package/commands/databases.js

@@ -0,0 +1,79 @@
+import { retryOnLock } from '../api.js';
+import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
+import { writer } from '../writer.js';
+const DATABASE_FIELDS = ['name', 'owner_name', 'created_at'];
+export const command = 'databases';
+export const describe = 'Manage databases';
+export const aliases = ['database', 'db'];
+export const builder = (argv) => argv
+    .usage('$0 databases <sub-command> [options]')
+    .options({
+    'project-id': {
+        describe: 'Project ID',
+        type: 'string',
+    },
+    branch: {
+        describe: 'Branch ID or name',
+        type: 'string',
+    },
+})
+    .middleware(fillSingleProject)
+    .command('list', 'List databases', (yargs) => yargs, async (args) => await list(args))
+    .command('create', 'Create a database', (yargs) => yargs.options({
+    name: {
+        describe: 'Database name',
+        type: 'string',
+        demandOption: true,
+    },
+    'owner-name': {
+        describe: 'Owner name',
+        type: 'string',
+    },
+}), async (args) => await create(args))
+    .command('delete <database>', 'Delete a database', (yargs) => yargs, async (args) => await deleteDb(args));
+export const handler = (args) => {
+    return args;
+};
+export const list = async (props) => {
+    const branchId = await branchIdFromProps(props);
+    const { data } = await props.apiClient.listProjectBranchDatabases(props.projectId, branchId);
+    writer(props).end(data.databases, {
+        fields: DATABASE_FIELDS,
+    });
+};
+export const create = async (props) => {
+    const branchId = await branchIdFromProps(props);
+    const owner = props.ownerName ??
+        (await props.apiClient
+            .listProjectBranchRoles(props.projectId, branchId)
+            .then(({ data }) => {
+            if (data.roles.length === 0) {
+                throw new Error(`No roles found in branch ${branchId}`);
+            }
+            if (data.roles.length > 1) {
+                throw new Error(`More than one role found in branch ${branchId}. Please specify the owner name. Roles: ${data.roles
+                    .map((r) => r.name)
+                    .join(', ')}`);
+            }
+            return data.roles[0].name;
+        }));
+    if (!owner) {
+        throw new Error('No owner found');
+    }
+    const { data } = await retryOnLock(() => props.apiClient.createProjectBranchDatabase(props.projectId, branchId, {
+        database: {
+            name: props.name,
+            owner_name: owner,
+        },
+    }));
+    writer(props).end(data.database, {
+        fields: DATABASE_FIELDS,
+    });
+};
+export const deleteDb = async (props) => {
+    const branchId = await branchIdFromProps(props);
+    const { data } = await retryOnLock(() => props.apiClient.deleteProjectBranchDatabase(props.projectId, branchId, props.database));
+    writer(props).end(data.database, {
+        fields: DATABASE_FIELDS,
+    });
+};

package/commands/databases.test.js

@@ -0,0 +1,51 @@
+import { describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('databases', () => {
+    testCliCommand({
+        name: 'list',
+        args: [
+            'databases',
+            'list',
+            '--project-id',
+            'test',
+            '--branch',
+            'test_branch',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create',
+        args: [
+            'databases',
+            'create',
+            '--project-id',
+            'test',
+            '--branch',
+            'test_branch',
+            '--name',
+            'test_db',
+            '--owner-name',
+            'test_owner',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'delete',
+        args: [
+            'databases',
+            'delete',
+            'test_db',
+            '--project-id',
+            'test',
+            '--branch',
+            'test_branch',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+});

package/commands/help.test.js

@@ -0,0 +1,11 @@
+import { describe, expect } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('help', () => {
+    testCliCommand({
+        name: 'without args',
+        args: [],
+        expected: {
+            stderr: expect.stringContaining(`neonctl <command> [options]`),
+        },
+    });
+});

package/{src/commands/index.ts → commands/index.js}

@@ -8,16 +8,15 @@ import * as roles from './roles.js';
 import * as operations from './operations.js';
 import * as cs from './connection_string.js';
 import * as setContext from './set_context.js';
-
 export default [
-  auth,
-  users,
-  projects,
-  ipAllow,
-  branches,
-  databases,
-  roles,
-  operations,
-  cs,
-  setContext,
+    auth,
+    users,
+    projects,
+    ipAllow,
+    branches,
+    databases,
+    roles,
+    operations,
+    cs,
+    setContext,
 ];

package/commands/ip_allow.js

@@ -0,0 +1,135 @@
+import { writer } from '../writer.js';
+import { fillSingleProject } from '../utils/enrichers.js';
+import { projectUpdateRequest } from '../parameters.gen.js';
+import { log } from '../log.js';
+const IP_ALLOW_FIELDS = [
+    'id',
+    'name',
+    'IP_addresses',
+    'primary_branch_only',
+];
+export const command = 'ip-allow';
+export const describe = 'Manage IP Allow';
+export const builder = (argv) => {
+    return argv
+        .usage('$0 ip-allow <sub-command> [options]')
+        .options({
+        'project-id': {
+            describe: 'Project ID',
+            type: 'string',
+        },
+    })
+        .middleware(fillSingleProject)
+        .command('list', 'List the IP allowlist', (yargs) => yargs, async (args) => {
+        await list(args);
+    })
+        .command('add [ips...]', 'Add IP addresses to the IP allowlist', (yargs) => yargs
+        .usage('$0 ip-allow add [ips...]')
+        .positional('ips', {
+        describe: 'The list of IP addresses to add',
+        type: 'string',
+        default: [],
+        array: true,
+    })
+        .options({
+        'primary-only': {
+            describe: projectUpdateRequest['project.settings.allowed_ips.primary_branch_only'].description,
+            type: 'boolean',
+        },
+    }), async (args) => {
+        await add(args);
+    })
+        .command('remove [ips...]', 'Remove IP addresses from the IP allowlist', (yargs) => yargs.usage('$0 ip-allow remove [ips...]').positional('ips', {
+        describe: 'The list of IP addresses to remove',
+        type: 'string',
+        default: [],
+        array: true,
+    }), async (args) => {
+        await remove(args);
+    })
+        .command('reset [ips...]', 'Reset the IP allowlist', (yargs) => yargs.usage('$0 ip-allow reset [ips...]').positional('ips', {
+        describe: 'The list of IP addresses to reset',
+        type: 'string',
+        default: [],
+        array: true,
+    }), async (args) => {
+        await reset(args);
+    });
+};
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const { data } = await props.apiClient.getProject(props.projectId);
+    writer(props).end(parse(data.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const add = async (props) => {
+    if (props.ips.length <= 0) {
+        throw new Error(`Enter individual IP addresses, define ranges with a dash, or use CIDR notation for more flexibility.
+       Example: neonctl ip-allow add 192.168.1.1, 192.168.1.20-192.168.1.50, 192.168.1.0/24 --project-id <id>`);
+    }
+    const project = {};
+    const { data } = await props.apiClient.getProject(props.projectId);
+    const existingAllowedIps = data.project.settings?.allowed_ips;
+    project.settings = {
+        allowed_ips: {
+            ips: [...new Set(props.ips.concat(existingAllowedIps?.ips ?? []))],
+            primary_branch_only: props.primaryOnly ?? existingAllowedIps?.primary_branch_only ?? false,
+        },
+    };
+    const { data: response } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(response.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const remove = async (props) => {
+    if (props.ips.length <= 0) {
+        throw new Error(`Remove individual IP addresses and ranges. Example: neonctl ip-allow remove 192.168.1.1 --project-id <id>`);
+    }
+    const project = {};
+    const { data } = await props.apiClient.getProject(props.projectId);
+    const existingAllowedIps = data.project.settings?.allowed_ips;
+    project.settings = {
+        allowed_ips: {
+            ips: existingAllowedIps?.ips?.filter((ip) => !props.ips.includes(ip)) ?? [],
+            primary_branch_only: existingAllowedIps?.primary_branch_only ?? false,
+        },
+    };
+    const { data: response } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(response.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const reset = async (props) => {
+    const project = {};
+    project.settings = {
+        allowed_ips: {
+            ips: props.ips,
+            primary_branch_only: false,
+        },
+    };
+    const { data } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(data.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+    if (props.ips.length <= 0) {
+        log.info(`The IP allowlist has been reset. All databases on project "${data.project.name}" are now exposed to the internet`);
+    }
+};
+const parse = (project) => {
+    const ips = project.settings?.allowed_ips?.ips ?? [];
+    return {
+        id: project.id,
+        name: project.name,
+        IP_addresses: ips,
+        primary_branch_only: project.settings?.allowed_ips?.primary_branch_only ?? false,
+    };
+};

package/commands/ip_allow.test.js

@@ -0,0 +1,78 @@
+import { describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('ip-allow', () => {
+    testCliCommand({
+        name: 'list IP allow',
+        args: ['ip-allow', 'list', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'list IP Allow with single-project',
+        args: ['ip-allow', 'list'],
+        mockDir: 'single_project',
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'Add IP allow - Error',
+        args: ['ip-allow', 'add', '--projectId', 'test'],
+        expected: {
+            code: 1,
+            stderr: `ERROR: Enter individual IP addresses, define ranges with a dash, or use CIDR notation for more flexibility.
+       Example: neonctl ip-allow add 192.168.1.1, 192.168.1.20-192.168.1.50, 192.168.1.0/24 --project-id <id>`,
+        },
+    });
+    testCliCommand({
+        name: 'Add IP allow',
+        args: [
+            'ip-allow',
+            'add',
+            '127.0.0.1',
+            '192.168.10.1-192.168.10.15',
+            '--primary-only',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'Remove IP allow - Error',
+        args: ['ip-allow', 'remove', '--project-id', 'test'],
+        expected: {
+            code: 1,
+            stderr: `ERROR: Remove individual IP addresses and ranges. Example: neonctl ip-allow remove 192.168.1.1 --project-id <id>`,
+        },
+    });
+    testCliCommand({
+        name: 'Remove IP allow',
+        args: ['ip-allow', 'remove', '192.168.1.1', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'Reset IP allow',
+        args: ['ip-allow', 'reset', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+            stdout: `id: test
+name: test_project
+IP_addresses: []
+primary_branch_only: false
+`,
+            stderr: `INFO: The IP allowlist has been reset. All databases on project "test_project" are now exposed to the internet`,
+        },
+    });
+    testCliCommand({
+        name: 'Reset IP allow to new list',
+        args: ['ip-allow', 'reset', '192.168.2.2', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+});

package/commands/operations.js

@@ -0,0 +1,28 @@
+import { fillSingleProject } from '../utils/enrichers.js';
+import { writer } from '../writer.js';
+const OPERATIONS_FIELDS = ['id', 'action', 'status', 'created_at'];
+export const command = 'operations';
+export const describe = 'Manage operations';
+export const aliases = ['operation'];
+export const builder = (argv) => argv
+    .usage('$0 operations <sub-command> [options]')
+    .options({
+    'project-id': {
+        describe: 'Project ID',
+        type: 'string',
+    },
+})
+    .middleware(fillSingleProject)
+    .command('list', 'List operations', (yargs) => yargs, async (args) => await list(args));
+export const handler = (args) => {
+    return args;
+};
+export const list = async (props) => {
+    const { data } = await props.apiClient.listProjectOperations({
+        projectId: props.projectId,
+        limit: props.limit,
+    });
+    writer(props).end(data.operations, {
+        fields: OPERATIONS_FIELDS,
+    });
+};

package/commands/operations.test.js

@@ -0,0 +1,11 @@
+import { describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('operations', () => {
+    testCliCommand({
+        name: 'list',
+        args: ['operations', 'list', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+});

package/commands/projects.js

@@ -0,0 +1,186 @@
+import { log } from '../log.js';
+import { projectCreateRequest, projectUpdateRequest, } from '../parameters.gen.js';
+import { writer } from '../writer.js';
+import { psql } from '../utils/psql.js';
+import { updateContextFile } from '../context.js';
+const PROJECT_FIELDS = ['id', 'name', 'region_id', 'created_at'];
+const REGIONS = [
+    'aws-us-west-2',
+    'aws-ap-southeast-1',
+    'aws-eu-central-1',
+    'aws-us-east-2',
+    'aws-us-east-1',
+];
+const PROJECTS_LIST_LIMIT = 100;
+export const command = 'projects';
+export const describe = 'Manage projects';
+export const aliases = ['project'];
+export const builder = (argv) => {
+    return argv
+        .usage('$0 projects <sub-command> [options]')
+        .command('list', 'List projects', (yargs) => yargs, async (args) => {
+        await list(args);
+    })
+        .command('create', 'Create a project', (yargs) => yargs.options({
+        name: {
+            describe: projectCreateRequest['project.name'].description,
+            type: 'string',
+        },
+        'region-id': {
+            describe: `The region ID. Possible values: ${REGIONS.join(', ')}`,
+            type: 'string',
+        },
+        psql: {
+            type: 'boolean',
+            describe: 'Connect to a new project via psql',
+            default: false,
+        },
+        database: {
+            describe: projectCreateRequest['project.branch.database_name'].description,
+            type: 'string',
+        },
+        role: {
+            describe: projectCreateRequest['project.branch.role_name'].description,
+            type: 'string',
+        },
+        'set-context': {
+            type: 'boolean',
+            describe: 'Set the current context to the new project',
+            default: false,
+        },
+    }), async (args) => {
+        await create(args);
+    })
+        .command('update <id>', 'Update a project', (yargs) => yargs.options({
+        name: {
+            describe: projectCreateRequest['project.name'].description,
+            type: 'string',
+        },
+        'ip-allow': {
+            describe: projectUpdateRequest['project.settings.allowed_ips.ips']
+                .description,
+            type: 'string',
+            array: true,
+            deprecated: "Deprecated. Use 'ip-allow' command",
+        },
+        'ip-primary-only': {
+            describe: projectUpdateRequest['project.settings.allowed_ips.primary_branch_only'].description,
+            type: 'boolean',
+            deprecated: "Deprecated. Use 'ip-allow' command",
+        },
+    }), async (args) => {
+        await update(args);
+    })
+        .command('delete <id>', 'Delete a project', (yargs) => yargs, async (args) => {
+        await deleteProject(args);
+    })
+        .command('get <id>', 'Get a project', (yargs) => yargs, async (args) => {
+        await get(args);
+    });
+};
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const getList = async (fn) => {
+        const result = [];
+        let cursor;
+        let end = false;
+        while (!end) {
+            const { data } = await fn({
+                limit: PROJECTS_LIST_LIMIT,
+                cursor,
+            });
+            result.push(...data.projects);
+            cursor = data.pagination?.cursor;
+            log.debug('Got %d projects, with cursor: %s', data.projects.length, cursor);
+            if (data.projects.length < PROJECTS_LIST_LIMIT) {
+                end = true;
+            }
+        }
+        return result;
+    };
+    const [ownedProjects, sharedProjects] = await Promise.all([
+        getList(props.apiClient.listProjects),
+        getList(props.apiClient.listSharedProjects),
+    ]);
+    const out = writer(props);
+    out.write(ownedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Projects',
+    });
+    out.write(sharedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Shared with me',
+    });
+    out.end();
+};
+const create = async (props) => {
+    const project = {};
+    if (props.name) {
+        project.name = props.name;
+    }
+    if (props.regionId) {
+        project.region_id = props.regionId;
+    }
+    project.branch = {};
+    if (props.database) {
+        project.branch.database_name = props.database;
+    }
+    if (props.role) {
+        project.branch.role_name = props.role;
+    }
+    const { data } = await props.apiClient.createProject({
+        project,
+    });
+    if (props.setContext) {
+        updateContextFile(props.contextFile, {
+            projectId: data.project.id,
+            branchId: data.branch.id,
+        });
+    }
+    const out = writer(props);
+    out.write(data.project, { fields: PROJECT_FIELDS, title: 'Project' });
+    out.write(data.connection_uris, {
+        fields: ['connection_uri'],
+        title: 'Connection URIs',
+    });
+    out.end();
+    if (props.psql) {
+        const connection_uri = data.connection_uris[0].connection_uri;
+        const psqlArgs = props['--'];
+        await psql(connection_uri, psqlArgs);
+    }
+};
+const deleteProject = async (props) => {
+    const { data } = await props.apiClient.deleteProject(props.id);
+    writer(props).end(data.project, {
+        fields: PROJECT_FIELDS,
+    });
+};
+const update = async (props) => {
+    const project = {};
+    if (props.name) {
+        project.name = props.name;
+    }
+    if (props.ipAllow || props.ipPrimaryOnly != undefined) {
+        const { data } = await props.apiClient.getProject(props.id);
+        const existingAllowedIps = data.project.settings?.allowed_ips;
+        project.settings = {
+            allowed_ips: {
+                ips: props.ipAllow ?? existingAllowedIps?.ips ?? [],
+                primary_branch_only: props.ipPrimaryOnly ??
+                    existingAllowedIps?.primary_branch_only ??
+                    false,
+            },
+        };
+    }
+    const { data } = await props.apiClient.updateProject(props.id, {
+        project,
+    });
+    writer(props).end(data.project, { fields: PROJECT_FIELDS });
+};
+const get = async (props) => {
+    const { data } = await props.apiClient.getProject(props.id);
+    writer(props).end(data.project, { fields: PROJECT_FIELDS });
+};