IN-886 Refactor Carbon app to use new Data Warehouse secret #94
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonavellecuerdo
force-pushed
the
IN-886-use-new-data-warehouse-secret
branch
from
892743b to
a3e21ae
Compare
Why these changes are being introduced: * Use the JSON formatted secret in Secrets Manager to obtain credentials for the Data Warehouse and remove redundant secrets. How this addresses that need: * Configure the engine with 'CONNECTION_STRING' * Create database connection test and add CLI option to run test * Add Make command to run database connection test * Remove unused 'click.echo' commands * Add error handling when retrieving database versions Side effects of this change: * None Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-886
jonavellecuerdo
force-pushed
the
IN-886-use-new-data-warehouse-secret
branch
from
a3e21ae to
6388c9b
Compare
ehanson8
requested changes
Aug 23, 2023
carbon/db.py
Outdated
Comment on lines
108
to
111
| def configure(self, conn: str, **kwargs: Any) -> None: # noqa: ANN401 | ||
| self._engine = self._engine or create_engine(conn, **kwargs) | ||
|
|
||
| def run_connection_test(self) -> None: |
There was a problem hiding this comment.
Docstrings would be beneficial for clarifying what's happening here
There was a problem hiding this comment.
Docstring has been added. ✍🏼
carbon/db.py
Outdated
|
|
||
| def configure(self, conn: str) -> None: | ||
| self._engine = self._engine or create_engine(conn) | ||
| def configure(self, conn: str, **kwargs: Any) -> None: # noqa: ANN401 |
There was a problem hiding this comment.
Let's start expanding some of these variable names like conn
There was a problem hiding this comment.
Please see the latest commit! The only line of code where I kept conn was in CarbonCopyFTPS.storbinary; the class inherits from FTP_TLS, which uses the conn naming convention.
* Update README * Clean up variable name 'conn' * Add docstring to DatabaseEngine.run_connection_test
ehanson8
approved these changes
Aug 24, 2023
| 5. Run any `make` commands for testing the application. | ||
|
|
||
| 2. Run `make dist-dev` to build the container. | ||
| Any tests that involve connecting to the Data Warehouse will need to be run as an ECS task in `stage`, which requires building and publishing the Docker container image to ECR for the `stage` environment. As noted in step 1, the appropriate AWS credentials for the `stage` must be set to run the commands for building and publishing the Docker container image. The `ECR_NAME_STAGE` and `ECR_URL_STAGE` environment variables must also be set; the values correspond to the 'Repository name' and 'URI' indicated on ECR for the container image, respectively. |
jonavellecuerdo
added a commit
that referenced
this pull request
Aug 25, 2023
Why these changes are being introduced: * Simplify management of FTP credentials by storing components in a JSON formatted string How this addresses that need: * Expand connection tests for Data Warehouse and Symplectic Elements FTP server * Update CLI tests * Update README Side effects of this change: * None Relevant ticket(s): * #94
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Refactor Carbon to use the JSON formatted secret in Secrets Manager to obtain the credentials for the Data Warehouse.
This will make future management of the Data Warehouse password a bit easier, since we will have just one secret in Secrets Manager instead of two.
Helpful background context
Updating Carbon to use Python 3.11 meant replacing
cx-oraclewithoracledb(i.e.,python-oracledb) because as this page reads: cx_Oracle 8.3 has been tested [only] with Python versions 3.6 through 3.10.The Oracle database version used by the Data Warehouse requires "thick" mode when connecting to a database. This page describes how to do that using
sqlalchemy.create_engine()andoracledb.init_oracle_client().I chose the solution to use
sqlalchemy.create_engine()since that is the method currently used by the application, and the latter method would involve more changes that--in my perspective--would better suit a separate ticket/effort to replace allsqlalchemycommands withoracledb.How can a reviewer manually see the effects of these changes?
Review the CloudWatch log generated by running
make database-connection-test-stageIf you'd like to run it
IN-886-use-new-data-warehouse-secret.make install.make lint.make database-connection-test-stage.Includes new or updated dependencies?
NO
Developer
Code Reviewer
(not just this pull request message)