https://github.com/samth/docker-racket-build
https://github.com/samth/docker-racket-build
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/samth/docker-racket-build
- Owner: samth
- License: mit
- Created: 2017-10-27T00:22:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-05T09:25:48.000Z (over 7 years ago)
- Last Synced: 2025-04-10T12:25:08.136Z (about 1 year ago)
- Language: Shell
- Size: 63.5 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
## Docker-ized build and test of Racket releases [](https://travis-ci.org/samth/docker-racket-build)
This repository provides Dockerfiles and `docker-compose` configuration for
installing and testing Racket versions, including official releases and
snapshot versions. The goal of this project is to reduce the manual effort
required to test and release new Racket versions, see the [Release Overview][1]
wiki page for details on that process.
### Quickstart `docker-compose` example commands
By default, all commands use the latest Racket snapshot version. See the `.env`
file and the [environments directory][5] for more information.
```shell
# Build a Racket installation
docker-compose build racket-x86-minimal
# Run a REPL in a built installation
docker-compose run racket-x86-minimal
# Build non-GUI release tests for an installation
docker-compose build racket-x86-minimal-test
# Run previously-built non-GUI release tests
docker-compose run racket-x86-minimal-test
# Start the GUI browser debugging services in the background
docker-compose up -d nginx
# Build and run GUI release tests
docker-compose build racket-x86-minimal-test-gui
docker-compose run racket-x86-minimal-test-gui
# Now open localhost in your browser (if debugging services are up)
# Run a different command in an already built image
docker-compose run racket-x86-minimal-test raco test -p my-collection
```
### Docker configuration overview
The [Docker Compose][2] configuration in `docker-compose.yml` defines a few
services for each installer variant:
- A `racket-{installer}` service on top of an image that simply installs Racket
and builds all installed packages. Running a container from this service drops
you into a Racket REPL.
- A `racket-{installer}-test` service built on top of the corresponding
`racket-{installer}` service. Running a container from this service runs
automated non-GUI release tests, specifically it runs the `test.sh` script.
- A `racket-{installer}-test-gui` service that's like the `-test` service, but
it runs GUI tests using an X server external to the service.
Several services are defined for use by the GUI tests, including:
- An X11 server implemented by `xvfb` used directly by the `-test-gui`
services. Unfortunately the X11 protocol is difficult to proxy in a
transparently distributed way, so only *one* `xvfb` container may be run at a
time and GUI test containers can't share the same container.
- A few proxy services that convert a read-only connection to the X11 service
into a VNC connection over Websockets. Like the X11 protocol, this is hard to
autoscale and only one container of each of these proxy services (`x11vnc` and
`websockify`) may be run at once.
- An NGINX webserver and a small service that builds the `noVNC` JS HTML5 app,
with the webserver hosting the app at `localhost:80`. The app connects to the
VNC-over-Websockets connection letting you watch what the GUI tests are doing
to the X11 server in real time by opening your browser and pressing the
"connect" button.
### Installer variants
Not all installer variants are installed and tested. The following is a
complete list of installer names used in the `racket-{installer}` services:
| Name | Meaning |
| --- | --- |
| `i386` | Linux 32-bit installer for main-distribution Racket |
| `i386-minimal` | Linux 32-bit installer for minimal Racket |
| `x86` | Linux 64-bit installer for main-distribution Racket |
| `x86-minimal` | Linux 64-bit installer for minimal Racket |
| `x86-natipkg` | Linux 64-bit installer for main-distribution Racket with bundled OS libraries |
| `x86-natipkg-minimal` | Linux 64-bit installer for minimal Racket with bundled OS libraries |
All installers are installed in-place, not Unix-style. The following
installation variants are yet to be tested:
- Unix-style installations of installers, which is easily doable,
- All from-source installations, which are harder but not especially difficult.
- Windows `.exe` installations, which might be possible
- MacOS `.dmg` installations, which is likely impossible
### Release tests included so far
This list mirrors the "Testing" section of the [Release Checklist][3], with all
items contained here automated and run in the Dockerized release tests:
* [ ] {Matthew Flatt }
- [ ] Racket Tests
```
racket -l tests/racket/test
```
- [ ] Languages Tests
```
racket -l tests/htdp-lang/test-htdp
```
- [ ] PCPS test suite (in "pcps-test" repo)
```
raco test -p pcps-test
```
* [ ] {Robby Findler }
- [ ] Contracts Tests:
```
racket -l tests/racket/contract/all
racket -l tests/racket/contract-stress-argmin
racket -l tests/racket/contract-stress-take-right
```
- [ ] Teachpacks Tests: image tests
```
racket -l 2htdp/tests/bitmap-as-image-in-universe
racket -l 2htdp/tests/image-equality-performance-htdp
racket -l 2htdp/tests/image-equality-performance
racket -l 2htdp/tests/image-too-large
racket -l 2htdp/tests/test-image
```
- [ ] PLaneT Tests:
```
# (the output of these tests is hard to read)
raco test -l tests/planet/run-all
```
* [ ] {Sam Tobin-Hochstadt }
- [ ] Match Tests:
```
raco test -l tests/match/main
```
- [ ] Typed Racket Tests:
```
racket -l typed-racket-test -- --all
```
* [ ] {Ryan Culpepper }
- [ ] syntax-parse Tests
```
raco test -c tests/stxparse
```
- [ ] Data Tests
```
raco test -c tests/data
```
- [ ] DB Tests
```
# basic tests with sqlite3; other tests require local software & configuration
racket -l tests/db/all-tests
```
- [ ] SRFI Tests
```
racket -l tests/srfi/run-tests
```
* [ ] {Jay McCarthy }
- [ ] XML Tests
```
raco test -c tests/xml
```
- [ ] HTML Tests
```
raco test -c tests/html
```
- [ ] PLAI Tests
```
raco test -c plai
```
- [ ] Racklog tests
```
raco test -c racklog/tests
```
- [ ] Datalog tests
```
raco test -c datalog/tests
```
* [ ] {Stevie Strickland }
- [ ] Unit Contract Tests
```
raco test -l tests/units/test-unit-contracts
```
- [ ] Contract Region Tests
```
racket -l tests/racket/contract/define-contract
racket -l tests/racket/contract/with-contract
```
- [ ] Class Contract Tests
```
racket -l tests/racket/contract/class
```
* [ ] {Stephen Chang }
- [ ] Lazy Racket Tests
```
raco test -l lazy/tests/main
```
* [ ] {David Van Horn , Sam Tobin-Hochstadt }
- [ ] EoPL Tests
```
raco test -c eopl/tests
```
See the [github issues][4] for more info on the status of automated release
tests not yet included in this list.
[1]: https://github.com/racket/racket/wiki/Release-overview
[2]: https://docs.docker.com/compose/
[3]: https://github.com/racket/racket/wiki/Release-Checklist
[4]: https://github.com/samth/docker-racket-build/issues
[5]: https://github.com/samth/docker-racket-build/tree/master/environments