fecgov / fecfile-image-generator Goto Github PK

Set up deployment of fecfile-image-generator to Cloud.gov

Issues that will/may need addressing

• Use of AWS SQS service. Queue service will need an equivalent in Cloud.gov.
• Use of local file system to write temporary files. Need to verify local file system is only used briefly as a local cache per https://12factor.net/processes.
• Installation of PDFtk binary on server. https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/
• Is the wkhtmltopdf tool still being used or was it replaced by PDFtk?

Note
This ticket does not include set up of an AWS SQS alternative service.

Acceptance Criteria
Responses from the server when these URLs are entered into a browser address after CircleCI deploys to the space:

• Development server: https://fecfile-image-generator-dev.app.cloud.gov/v1/app-name
• Stage server: https://fecfile-image-generator-stage.app.cloud.gov/v1/app-name
• Production server: https://fecfile-image-generator-prod.app.cloud.gov/v1/app-name

QA
This ticket is to simply get the code to deploy to the Cloud.gov environments. There are known issues with the actual code which are to be addressed in future tickets. To verify the code has been deployed, you can view "fecfile-image-generator" on a page in the links in the Acceptance Criteria above.

#Consideration
To keep things consistent with the rest of the FEC repos, could we rename this repo to fecfile-image-generator (instead of a capitals I & V, and add a -)?

#Possible complications
Would this break anything? -- We renamed the fecfile-online repo to fecfile-web-app on Jan. 18 and have not uncovered any problems related to the name change yet. ZenHub handled the change gracefully.

Acceptance Criteria

• The name of the image generator GitHub repo is: fecfile-image-generator

Python linting errors remain (see CircleCI output) - we should fix them so we don't create new problems.

For CircleCI, set up the .circleci/config.yml with:

• dependency-check
• unit-test

Setup SonarCloud communication with fecfile-image-generator GitHub account.

Acceptance Criteria

• CircleCI reports in CircleCI dashboard for repo
• CircleCI report in GitHub when branch committed
• SonarCloud report in GitHub when branch committed

We're currently running python 3.8 for the fecfile-web-api so we should update to keep the apps running on the same python version

Code shouldn't deploy until automated checks pass.

Business Reason

As a [role], I will be able to [blank] so that I can [business reason]

Acceptance Criteria

If [precedent]
When [action]
Then [result]