FFS-1729: Add dockerfile to the application #68
Conversation
| # ARM64 architecture (i.e., Apple Silicon). Set a flag to skip the chromium | ||
| # download unless the current architecture is ARM64. | ||
| # | ||
| ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true |
There was a problem hiding this comment.
you laid this out in the PR notes. do you want to default this to true or false? which is least risky? are you sure that skipping the download will result in successful cases even if the user doesn't match your test on line 17?
There was a problem hiding this comment.
I defaulted this to true based on the examples I saw when researching this issue. With that said, it makes sense to me. When building the image on our laptops, we know that our macs use arm64. But, the architecture for running the github actions (which will also build the image) will likely not be arm64. Regardless, the if/then logic check has to happen to flip the skip switch whether or not the ENV var is initialized to true or false.
Reference: puppeteer/puppeteer#7740
|
|
||
| ### Running the application in a docker container | ||
|
|
||
| ##### Prerequisite steps |
There was a problem hiding this comment.
for the PUPPETEER workaround, do you want to reference that here just in case people run into some unexpected failure state with it?
There was a problem hiding this comment.
Readme updated.
Ticket number
FFS-1729
Overview of changes
Dockerfile
A
Dockerfilewas created so that a docker image containing the application can be used locally and, ultimately, registered and deployed.It is important to note that the testing libraries have a dependency on the open-source chromium browser. However, hardware with ARM64 architecture (i.e., some macbooks) will not have chromium. This is a known issue that can be resolved by setting the
PUPPETEER_SKIP_CHROMIUM_DOWNLOADflag tofalsewhen building the docker image on ARM64 hardware to force the install of chromium.README
Instructions were added to the README to guide readers through the building an image and then running it. The local development instructions were also expanded to be more specific. Some minor rearrangement of the content was done to group like content.
Testing