search

robota-suite / robota-core

A Python package for reading in elements of GitLab and GitHub repositories, for further analysis.
https://robota-core.readthedocs.io
MIT License
0 stars 8 forks source link

Add Dockerfile for development #13

Open tcassar opened 1 month ago

tcassar commented 1 month ago

Add a Dockerfile

This standardises an environment that can be used for development.

Relates to issue #6

tcassar commented 3 weeks ago

All sounds good. Thank you for looking over the PR, I will make the changes you suggested.

I will rewrite the Dockerfile to specifically focus on running the unit test framework in an isolated environment. If you think it is helpful I can build in things like pdb, or an SSH server for remote debugging, to help developers when their tests fail.

If you would like a lighter-weight Dockerfile however, or think these features are unnecessary, I can do that as well.

suzanneEmbury commented 1 week ago

Great - thanks.

I was just thinking of adding an instruction to run the tests, inside the Docker container, just to round out the steps taken: make the container, run something in it, shutdown the container.

But maybe more is required to run the tests that I'm not seeing? Could you give me an outline of what extra the Dockerfile would need to allow the tests to be run?

Being able to run pdb sounds great, though I think we'd need a pre-commit check to make sure no one had left the breakpoints in their code when committing. Maybe better to leave this for a separate PR that could consider this as well?