declapract-typescript-ehmpathy 0.49.15 → 0.50.0

package/dist/.test/assets/git/declarations/practices/persist-with-rds/__snapshots__/.declapract.integration.test.ts.snap

@@ -0,0 +1,45 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds — old-dev-config-location relocate + access-migrate (row-4 clamp) given: [case1] an rds repo with a config/dev.json to migrate when: [t0] the migration input (before any fix) then: config/dev.json holds the dev access + the placeholder + matches snapshot: config/dev.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "dev"
+  },
+  "database": {
+    "host": "bastion.dev.example.com",
+    "tunnel": "aws.ssmproxy.mydb.dev",
+    "password": "__CHANG3_ME__"
+  },
+  "upstream": {
+    "paypal": "api.dev.paypal.com"
+  },
+  "auth": {
+    "callbackUrl": "https://auth.myapp.dev"
+  }
+}
+"
+`;
+
+exports[`persist-with-rds — old-dev-config-location relocate + access-migrate (row-4 clamp) given: [case1] an rds repo with a config/dev.json to migrate when: [t1] the relocate + migrate fix is applied then: config/prep.json now holds the migrated content + config/dev.json is gone + matches snapshot: config/prep.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "database": {
+    "host": "bastion.dev.example.com",
+    "tunnel": "aws.ssmproxy.mydb.dev",
+    "password": "__CHANG3_ME__"
+  },
+  "upstream": {
+    "paypal": "api.dev.paypal.com"
+  },
+  "auth": {
+    "callbackUrl": "https://auth.myapp.dev"
+  }
+}
+"
+`;

package/dist/.test/assets/git/declarations/practices/persist-with-rds/__snapshots__/.extensions.sql.declapract.integration.test.ts.snap

@@ -0,0 +1,77 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`.extensions.sql fix given: [case1] a repo whose .extensions.sql predates the template and holds custom lines when: [t0] before any apply then: the input file matches snapshot: .extensions.sql — before 1`] = `
+"/**
+ NOTE: because db owner is not allowed to create extensions, these changes are applied manually
+
+  NOTE: for the integration test db, these are applied automatically when the docker instance starts
+*/
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+CREATE EXTENSION IF NOT EXISTS "cube";
+CREATE EXTENSION IF NOT EXISTS "earthdistance";
+"
+`;
+
+exports[`.extensions.sql fix given: [case1] a repo whose .extensions.sql predates the template and holds custom lines when: [t1] apply runs then: the output matches snapshot: .extensions.sql — after 1`] = `
+"/**
+ * postgres databases use extensions to increase functionality
+ * - we have a minimum set of extensions that are required for sql-schema-generator
+ * - services may also include their own extensions if they want additional functionality
+ * - this is not managed by sql-schema-control
+ *   - requires superuser privileges, cicd user only has db_owner privileges
+ * - this is applied
+ *   - automatically for integration-test db (through \`provision/docker/.../init/\` directory, with files cp'd by npm provision scripts)
+ *   - by the deployment script for live deployments
+ */
+
+-- extensions required for all sql-schema-generator resources:
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+
+-- extensions required for custom use cases in this service:
+CREATE EXTENSION IF NOT EXISTS "cube";
+CREATE EXTENSION IF NOT EXISTS "earthdistance";
+"
+`;
+
+exports[`.extensions.sql fix should be able to create a new file to fix case where file does not exist yet 1`] = `
+"/**
+ * postgres databases use extensions to increase functionality
+ * - we have a minimum set of extensions that are required for sql-schema-generator
+ * - services may also include their own extensions if they want additional functionality
+ * - this is not managed by sql-schema-control
+ *   - requires superuser privileges, cicd user only has db_owner privileges
+ * - this is applied
+ *   - automatically for integration-test db (through \`provision/docker/.../init/\` directory, with files cp'd by npm provision scripts)
+ *   - by the deployment script for live deployments
+ */
+
+-- extensions required for all sql-schema-generator resources:
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+
+-- extensions required for custom use cases in this service:
+-- CREATE EXTENSION IF NOT EXISTS ..."
+`;
+
+exports[`.extensions.sql fix should be able to fix a file with custom extensions correctly 1`] = `
+"/**
+ * postgres databases use extensions to increase functionality
+ * - we have a minimum set of extensions that are required for sql-schema-generator
+ * - services may also include their own extensions if they want additional functionality
+ * - this is not managed by sql-schema-control
+ *   - requires superuser privileges, cicd user only has db_owner privileges
+ * - this is applied
+ *   - automatically for integration-test db (through \`provision/docker/.../init/\` directory, with files cp'd by npm provision scripts)
+ *   - by the deployment script for live deployments
+ */
+
+-- extensions required for all sql-schema-generator resources:
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+
+-- extensions required for custom use cases in this service:
+CREATE EXTENSION IF NOT EXISTS "cube";
+CREATE EXTENSION IF NOT EXISTS "earthdistance";"
+`;

package/dist/.test/assets/git/declarations/practices/persist-with-rds/__snapshots__/config-validates-schema.declapract.integration.test.ts.snap

@@ -0,0 +1,500 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/prep.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-abc123.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/prod.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-def456.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/test.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prep.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param/test-org/test-project/prep/legacy.plan)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "hand-set-cluster"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-abc123.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prep.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param/test-org/test-project/prep/legacy.plan)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "hand-set-cluster"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "cluster.prep.example.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prod.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-def456.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      },
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prod.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": "vpc-main-bastion",
+      "cluster": "testdb",
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "cluster.prod.example.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/test.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null,
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/test.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": "vpc-main-bastion",
+      "cluster": "testdb",
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null
+    }
+  }
+}
+"
+`;

package/dist/.test/assets/git/declarations/practices/persist-with-rds/__snapshots__/database-wrappers-typecheck.declapract.integration.test.ts.snap

@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds database wrappers type-check where they land (#627, #633) given: [case2] the jsdoc example that withDatabaseContext ships when: [t0] tsc runs over the example, as an adopter would paste it then: the example matches snapshot: withDatabaseContext jsdoc example 1`] = `
+"  const findById = withDatabaseContext(({ id }: { id: string }, context: { dbConnection: DatabaseConnection }) => {
+    // do logic with dbConnection
+  });
+  // ...
+  await findById({ id: '821' }, {}); // the context is required, but the dbConnection within it is not
+  await findById({ id: '821' }, { dbConnection }); // pass one in to reuse it, e.g. inside a transaction"
+`;