neonctl 1.28.0 → 1.29.1

package/src/commands/ip_allow.ts

@@ -0,0 +1,202 @@
+import yargs from 'yargs';
+import { CommonProps, ProjectScopeProps } from '../types';
+import { writer } from '../writer.js';
+import { fillSingleProject } from '../utils/enrichers.js';
+import { Project, ProjectUpdateRequest } from '@neondatabase/api-client';
+import { projectUpdateRequest } from '../parameters.gen.js';
+import { log } from '../log.js';
+
+const IP_ALLOW_FIELDS = [
+  'id',
+  'name',
+  'IP_addresses',
+  'primary_branch_only',
+] as const;
+
+export const command = 'ip-allow';
+export const describe = 'Manage IP Allow';
+export const builder = (argv: yargs.Argv) => {
+  return argv
+    .usage('$0 ip-allow <sub-command> [options]')
+    .options({
+      'project-id': {
+        describe: 'Project ID',
+        type: 'string',
+      },
+    })
+    .middleware(fillSingleProject as any)
+    .command(
+      'list',
+      'List the IP allowlist',
+      (yargs) => yargs,
+      async (args) => {
+        await list(args as any);
+      },
+    )
+    .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 as any);
+      },
+    )
+    .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 as any);
+      },
+    )
+    .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 as any);
+      },
+    );
+};
+
+export const handler = (args: yargs.Argv) => {
+  return args;
+};
+
+const list = async (props: CommonProps & ProjectScopeProps) => {
+  const { data } = await props.apiClient.getProject(props.projectId);
+  writer(props).end(parse(data.project), {
+    fields: IP_ALLOW_FIELDS,
+  });
+};
+
+const add = async (
+  props: CommonProps &
+    ProjectScopeProps & {
+      ips: string[];
+      primaryOnly?: boolean;
+    },
+) => {
+  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: ProjectUpdateRequest['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: ProjectScopeProps & { ips: string[] }) => {
+  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: ProjectUpdateRequest['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: ProjectScopeProps & { ips: string[] }) => {
+  const project: ProjectUpdateRequest['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: 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/src/commands/operations.test.ts

@@ -0,0 +1,13 @@
+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/src/commands/operations.ts

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

package/src/commands/projects.test.ts

@@ -0,0 +1,147 @@
+import { afterAll, describe, expect, test } from '@jest/globals';
+import { readFileSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+
+const CONTEXT_FILE = join(tmpdir(), `neon_project_create_ctx_${Date.now()}`);
+
+describe('projects', () => {
+  testCliCommand({
+    name: 'list',
+    args: ['projects', 'list'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create',
+    args: ['projects', 'create', '--name', 'test_project'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create with database and role',
+    args: [
+      'projects',
+      'create',
+      '--name',
+      'test_project',
+      '--database',
+      'test_db',
+      '--role',
+      'test_role',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create and connect with psql',
+    args: ['projects', 'create', '--name', 'test_project', '--psql'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create and connect with psql and psql args',
+    args: [
+      'projects',
+      'create',
+      '--name',
+      'test_project',
+      '--psql',
+      '--',
+      '-c',
+      'SELECT 1',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create project with setting the context',
+    args: [
+      'projects',
+      'create',
+      '--name',
+      'test_project',
+      '--context-file',
+      CONTEXT_FILE,
+      '--set-context',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  afterAll(() => {
+    rmSync(CONTEXT_FILE);
+  });
+
+  test('context file should exist and contain the project id', () => {
+    expect(readFileSync(CONTEXT_FILE, 'utf-8')).toContain('new-project-123456');
+  });
+
+  testCliCommand({
+    name: 'delete',
+    args: ['projects', 'delete', 'test'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'update name',
+    args: ['projects', 'update', 'test', '--name', 'test_project_new_name'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'update ip allow',
+    args: [
+      'projects',
+      'update',
+      'test',
+      '--ip-allow',
+      '127.0.0.1',
+      '192.168.1.2/22',
+      '--ip-primary-only',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'update ip allow primary only flag',
+    args: ['projects', 'update', 'test', '--ip-primary-only', 'false'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'update ip allow remove',
+    args: ['projects', 'update', 'test', '--ip-allow'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'get',
+    args: ['projects', 'get', 'test'],
+    expected: {
+      snapshot: true,
+    },
+  });
+});

package/src/commands/projects.ts

@@ -0,0 +1,275 @@
+import {
+  ProjectCreateRequest,
+  ProjectListItem,
+  ProjectUpdateRequest,
+} from '@neondatabase/api-client';
+import yargs from 'yargs';
+
+import { log } from '../log.js';
+import {
+  projectCreateRequest,
+  projectUpdateRequest,
+} from '../parameters.gen.js';
+import { CommonProps, IdOrNameProps } from '../types.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'] as const;
+
+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: yargs.Argv) => {
+  return argv
+    .usage('$0 projects <sub-command> [options]')
+    .command(
+      'list',
+      'List projects',
+      (yargs) => yargs,
+      async (args) => {
+        await list(args as any);
+      },
+    )
+    .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 as any);
+      },
+    )
+    .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 as any);
+      },
+    )
+    .command(
+      'delete <id>',
+      'Delete a project',
+      (yargs) => yargs,
+      async (args) => {
+        await deleteProject(args as any);
+      },
+    )
+    .command(
+      'get <id>',
+      'Get a project',
+      (yargs) => yargs,
+      async (args) => {
+        await get(args as any);
+      },
+    );
+};
+export const handler = (args: yargs.Argv) => {
+  return args;
+};
+
+const list = async (props: CommonProps) => {
+  const getList = async (
+    fn:
+      | typeof props.apiClient.listProjects
+      | typeof props.apiClient.listSharedProjects,
+  ) => {
+    const result: ProjectListItem[] = [];
+    let cursor: string | undefined;
+    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: CommonProps & {
+    name?: string;
+    regionId?: string;
+    database?: string;
+    role?: string;
+    psql: boolean;
+    setContext: boolean;
+    '--'?: string[];
+  },
+) => {
+  const project: ProjectCreateRequest['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: CommonProps & IdOrNameProps) => {
+  const { data } = await props.apiClient.deleteProject(props.id);
+  writer(props).end(data.project, {
+    fields: PROJECT_FIELDS,
+  });
+};
+
+const update = async (
+  props: CommonProps &
+    IdOrNameProps & {
+      name?: string;
+      ipAllow?: string[];
+      ipPrimaryOnly?: boolean;
+    },
+) => {
+  const project: ProjectUpdateRequest['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: CommonProps & IdOrNameProps) => {
+  const { data } = await props.apiClient.getProject(props.id);
+  writer(props).end(data.project, { fields: PROJECT_FIELDS });
+};