rds_ssm_connect 1.0.1 → 1.0.3

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,17 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,6 +1,6 @@
 # AWS Environment Selector and Command Executor
 
-This Node.js application allows you to select an AWS environment and execute various AWS commands within that environment. The environments are read from your AWS configuration file, and the application uses the `aws-vault` tool to securely manage your AWS credentials.
+This Node.js application allows you to select an AWS environment and execute various AWS commands within that environment. The environments are read from your AWS configuration file, and the application uses the `aws-vault` tool to manage your AWS credentials securely.
 
 ## Prerequisites
 
@@ -10,16 +10,14 @@ Before running this application, make sure you have the following installed:
 - `aws-vault` tool: You can install it following the instructions on the [official GitHub page](https://github.com/99designs/aws-vault).
 - AWS CLI: You can install it following the instructions on the [official AWS page](https://aws.amazon.com/cli/).
 
-Also, ensure that your AWS configuration file (`~/.aws/config`) is properly set up with the environments you want to use.
+Also, ensure that your AWS configuration file (`~/.aws/config`) is appropriately set up with the environments you want to use.
 
 ## Installation
 
-1. Clone the repository or download the source code.
-2. Navigate to the project directory.
-3. Install the necessary Node.js dependencies by running:
+You can install this application globally using npm:
 
 ```bash
-npm install
+npm install -g rds_ssm_connect
 ```
 
 ## Usage
@@ -27,7 +25,7 @@ npm install
 1. Run the application. It will read your AWS configuration file and prompt you to select an environment.
 
 ```bash
-node connect.js
+rds_ssm_connect
 ```
 
 2. Select the environment you want to use. The application will then execute a series of AWS commands within that environment.
@@ -42,11 +40,7 @@ This application requires the following Node.js modules:
 - `os`: For getting the user's home directory.
 - `path`: For working with file paths.
 
-You can install these modules by running:
-
-```bash
-npm install child_process inquirer fs os path
-```
+These modules will be installed automatically when you install the application with npm.
 
 ## How It Works
 
@@ -54,10 +48,11 @@ The application first reads the AWS configuration file and extracts the environm
 
 After the user selects an environment, the application executes a series of AWS commands within that environment using `aws-vault`. These commands include:
 
-- Describing SSM parameters to get the name of the parameter containing the RDS password.
+- Describing SSM parameters to get the parameter's name containing the RDS password.
 - Getting the value of the RDS password parameter.
 - Describing EC2 instances to get the ID of the bastion instance.
 - Describing RDS DB clusters to get the endpoint of the RDS cluster.
 - Starting an AWS SSM session to forward a local port to the RDS cluster.
 
 The application logs the output of each command and any errors that occur.
+

package/connect.js

@@ -16,102 +16,123 @@ const awsConfig = fs.readFileSync(awsConfigPath, 'utf-8');
 // Extract environments from AWS config file
 const ENVS = awsConfig
   .split('\n')
-  .filter(line => line.startsWith('[') && line.endsWith(']'))
-  .map(line => line.slice(1, -1))
-  .map(line => line.replace('profile ', ''));
-
-// Prompt the user to select an environment
-inquirer
-  .prompt([
-    {
-      type: 'list',
-      name: 'ENV',
-      message: 'Please select the environment:',
-      choices: ENVS,
-    },
-  ])
-  .then((answers) => {
-    const ENV = answers.ENV; // Get the selected environment from the user's answers
-    console.log(`You selected: ${ENV}`);
-
-    // Set up the commands to run inside the aws-vault environment
-    const awsVaultExecCommand = ['aws-vault', 'exec', ENV, '--'];
-    const ssmDescribeCommand = 'aws ssm describe-parameters --region us-east-2 --query \'Parameters[?ends_with(Name, `/rds/rds-aurora-password`)].Name\' --output text | head -n 1';
-
-    // Run the commands inside aws-vault environment
-    const ssmDescribeProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${ssmDescribeCommand}`]);
-
-    // Get the name of the parameter containing the RDS password
-    ssmDescribeProcess.stdout.on('data', (data) => {
-      const PARAM_NAME = data.toString().trim();
-
-      // Get the RDS credentials
-      const ssmGetCommand = `aws ssm get-parameter --region us-east-2 --name '${PARAM_NAME}' --with-decryption --query Parameter.Value --output text`;
-      const ssmGetProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${ssmGetCommand}`]);
-
-      // Parse the JSON output of the ssm get-parameter command to get the RDS credentials
-      ssmGetProcess.stdout.on('data', (data) => {
-        const CREDENTIALS = JSON.parse(data.toString());
-        const USERNAME = CREDENTIALS.user; // Get the RDS username from the credentials
-        const PASSWORD = CREDENTIALS.password; // Get the RDS password from the credentials
-
-        // Display connection credentials and connection string
-        console.log(`Your connection string is: psql -h localhost -p 5432 -U ${USERNAME} -d emr`);
-        console.log(`Use the password: ${PASSWORD}`);
-
-        // Get the ID of the bastion instance
-        const instanceIdCommand = `aws ec2 describe-instances --region us-east-2 --filters "Name=tag:Name,Values='*bastion*'" --query "Reservations[].Instances[].[InstanceId]" --output text`;
-        const instanceIdProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${instanceIdCommand}`]);
-
-        instanceIdProcess.stdout.on('data', (data) => {
-          const INSTANCE_ID = data.toString().trim();
-
-          if (!INSTANCE_ID) {
-            console.error('Failed to find the instance with tag Name=*bastion*.');
-            return;
-          }
-
-          // Get the endpoint of the RDS cluster
-          const rdsEndpointCommand = `aws rds describe-db-clusters --region us-east-2 --query "DBClusters[?contains(DBClusterIdentifier, 'rds-aurora')].Endpoint" --output text`;
-          const rdsEndpointProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${rdsEndpointCommand}`]);
-
-          rdsEndpointProcess.stdout.on('data', (data) => {
-            const RDS_ENDPOINT = data.toString().trim();
-
-            if (!RDS_ENDPOINT) {
-              console.error('Failed to find the RDS endpoint.');
+    .filter(line => line.startsWith('[') && line.endsWith(']'))
+    .map(line => line.slice(1, -1))
+    .map(line => line.replace('profile ', ''));
+
+  // Define a mapping of environment suffixes to port numbers
+  const envPortMapping = {
+    'dev': '5433',
+    'stage': '5434',
+    'pre-prod': '5435',
+    'prod': '5436',
+  };
+
+  // Prompt the user to select an environment
+  inquirer
+    .prompt([
+      {
+        type: 'list',
+        name: 'ENV',
+        message: 'Please select the environment:',
+        choices: ENVS,
+      },
+    ])
+
+    .then((answers) => {
+      const ENV = answers.ENV; // Get the selected environment from the user's answers
+      console.log(`You selected: ${ENV}`);
+    
+      // Extract the environment suffix from the selected environment
+      const envSuffix = ENV.split('-').pop();
+    
+      // Get the corresponding port number for the environment
+      let portNumber = envPortMapping[envSuffix]; // Declare portNumber as a let variable
+    
+      // If no port number is found for the environment, default to 5432
+      if (!portNumber) {
+        console.error(`No port number found for environment: ${ENV}. Defaulting to 5432.`);
+        portNumber = '5432';
+      }
+
+      // Set up the commands to run inside the aws-vault environment
+      const awsVaultExecCommand = ['aws-vault', 'exec', ENV, '--'];
+      const ssmDescribeCommand = 'aws ssm describe-parameters --region us-east-2 --query \'Parameters[?ends_with(Name, `/rds/rds-aurora-password`)].Name\' --output text | head -n 1';
+
+      // Run the commands inside aws-vault environment
+      const ssmDescribeProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${ssmDescribeCommand}`]);
+
+      // Get the name of the parameter containing the RDS password
+      ssmDescribeProcess.stdout.on('data', (data) => {
+        const PARAM_NAME = data.toString().trim();
+
+        // Get the RDS credentials
+        const ssmGetCommand = `aws ssm get-parameter --region us-east-2 --name '${PARAM_NAME}' --with-decryption --query Parameter.Value --output text`;
+        const ssmGetProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${ssmGetCommand}`]);
+
+        // Parse the JSON output of the ssm get-parameter command to get the RDS credentials
+        ssmGetProcess.stdout.on('data', (data) => {
+          const CREDENTIALS = JSON.parse(data.toString());
+          const USERNAME = CREDENTIALS.user; // Get the RDS username from the credentials
+          const PASSWORD = CREDENTIALS.password; // Get the RDS password from the credentials
+
+          // Display connection credentials and connection string
+          console.log(`Your connection string is: psql -h localhost -p ${portNumber} -U ${USERNAME} -d emr`);
+          console.log(`Use the password: ${PASSWORD}`);
+
+          // Get the ID of the bastion instance
+          const instanceIdCommand = `aws ec2 describe-instances --region us-east-2 --filters "Name=tag:Name,Values='*bastion*'" --query "Reservations[].Instances[].[InstanceId]" --output text`;
+          const instanceIdProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${instanceIdCommand}`]);
+
+          instanceIdProcess.stdout.on('data', (data) => {
+            const INSTANCE_ID = data.toString().trim();
+
+            if (!INSTANCE_ID) {
+              console.error('Failed to find the instance with tag Name=*bastion*.');
               return;
             }
 
-            // Start a port forwarding session to the RDS cluster
-            const portForwardingCommand = `aws ssm start-session --target ${INSTANCE_ID} --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters "host=${RDS_ENDPOINT},portNumber='5432',localPortNumber='5432'" --cli-connect-timeout 0`;
-            const portForwardingProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${portForwardingCommand}`]);
+            // Get the endpoint of the RDS cluster
+            const rdsEndpointCommand = `aws rds describe-db-clusters --region us-east-2 --query "DBClusters[?contains(DBClusterIdentifier, 'rds-aurora')].Endpoint" --output text`;
+            const rdsEndpointProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${rdsEndpointCommand}`]);
 
-            portForwardingProcess.stdout.on('data', (data) => {
-              console.log(data.toString().trim());
+            rdsEndpointProcess.stdout.on('data', (data) => {
+              const RDS_ENDPOINT = data.toString().trim();
+
+              if (!RDS_ENDPOINT) {
+                console.error('Failed to find the RDS endpoint.');
+                return;
+              }
+
+              // Start a port forwarding session to the RDS cluster
+              const portForwardingCommand = `aws ssm start-session --target ${INSTANCE_ID} --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters "host=${RDS_ENDPOINT},portNumber='${portNumber}',localPortNumber='${portNumber}'" --cli-connect-timeout 0`;
+              const portForwardingProcess = spawn('sh', ['-c', `${awsVaultExecCommand.join(' ')} ${portForwardingCommand}`]);
+
+              portForwardingProcess.stdout.on('data', (data) => {
+                console.log(data.toString().trim());
+              });
+
+              portForwardingProcess.stderr.on('data', (data) => {
+                console.error(`Command execution error: ${data.toString()}`);
+              });
             });
 
-            portForwardingProcess.stderr.on('data', (data) => {
+            rdsEndpointProcess.stderr.on('data', (data) => {
               console.error(`Command execution error: ${data.toString()}`);
             });
           });
 
-          rdsEndpointProcess.stderr.on('data', (data) => {
+          instanceIdProcess.stderr.on('data', (data) => {
             console.error(`Command execution error: ${data.toString()}`);
           });
         });
 
-        instanceIdProcess.stderr.on('data', (data) => {
+        ssmGetProcess.stderr.on('data', (data) => {
           console.error(`Command execution error: ${data.toString()}`);
         });
       });
 
-      ssmGetProcess.stderr.on('data', (data) => {
+      ssmDescribeProcess.stderr.on('data', (data) => {
         console.error(`Command execution error: ${data.toString()}`);
       });
     });
-
-    ssmDescribeProcess.stderr.on('data', (data) => {
-      console.error(`Command execution error: ${data.toString()}`);
-    });
-  });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rds_ssm_connect",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "module",
   "dependencies": {
     "@aws-sdk/client-ec2": "^3.363.0",