Revive the docker image used to take cypress snapshots #3197
Conversation
vdonato
force-pushed
the
revive-snapshot-image
branch
2 times, most recently
from
d1bd50a to
bbafe93
Compare
This should make it possible to generate and update snapshots without relying on CI in some way (either by deleting snapshots to have CI regenerate them or having CI generate diffs to be processed by the cropping script) After this PR goes in, I'll spend some time reworking our wiki pages to include instructions on how to use this image as well as an overview of all of the available options for updating snapshots. Unfortunately, this isn't a perfect cure for our snapshot woes for a few reasons. * it takes *forever* to build image, mostly due to the length of time it takes to install Python dependencies. As far as I can tell, this is naturally quite slow, and there's not much we can do about it. * for whatever reason I'm having trouble getting component-template tests to work, but this is just a minor annoyance for now as those don't change much. This does mean that you can't run all e2e tests easily since they'll fail midway through due to these tests blowing up, but doing this takes so long that it seems unlikely that it'll be done often anyway.
vdonato
force-pushed
the
revive-snapshot-image
branch
from
bbafe93 to
77d711f
Compare
| image: streamlit_circleci | ||
| build: . | ||
| ports: | ||
| - "3000:3000" |
There was a problem hiding this comment.
Is this port mapping is redundant in the previous version?
There was a problem hiding this comment.
The port mapping here was actually used to expose port 3000 of the docker container to the local machine, and I decided that it's most likely annoying to have to stop the local dev server that people normally have already-running on port 3000 when taking snapshots
I think ideally, we would want the docker container to be able to access the host machine's react dev server (it currently has to spin up its own when running tests), but that ends up being annoying to get working in both MacOS and Linux because
- you can only use
localhostin the container to access the host machine in Linux and not MacOS - on MacOS, you can access the special DNS name
host.docker.internalwithin a container to talk to the host, but this DNS name doesn't work on Linux without passing some additional flags - we would have to change all of our e2e tests to use either
localhostorhost.docker.internaldepending on the environment the test is being run in
This might be something we want to smooth out later when there's time to do so, but for now totally isolating the container's dev server seems okay to me
2 participants
This should make it possible to generate and update snapshots without relying
on CI in some way (either by deleting snapshots to have CI regenerate them or
having CI generate diffs to be processed by the cropping script)
After this PR goes in, I'll spend some time reworking our wiki pages to include
instructions on how to use this image as well as an overview of all of the
available options for updating snapshots.
Unfortunately, this isn't a perfect cure for our snapshot woes for a few
reasons.
takes to install Python dependencies. As far as I can tell, this is
naturally quite slow, and there's not much we can do about it.
tests to work, but this is just a minor annoyance for now as those
don't change much. This does mean that you can't run all e2e tests
easily since they'll fail midway through due to these tests blowing
up, but doing this takes so long that it seems unlikely that it'll be
done often anyway.
Closes #2682