shpark / au-fsv23

CIS 5000 Fall 23 - Forked version of Docker container for Formal Software Verification 2022 course

au-fsv22

Docker container for courses based on the Software Foundations book. The container can be used for easy cross-platform Coq development using Visual Studio Code. The container configuration will automatically install the VsCoq extenstion for Visual Studio Code and configure Coq related settings.

The image uses Coq 8.15.2 and includes all dependencies needed to complete the following Software Foundations volumes:

• Logical Foundations (Volume 1)
• Programming Language Foundations (Volume 2)
• Verified Functional Algorithms (Volume 3)
• QuickChick: Property-Based Testing in Coq (Volume 4)
• Separation Logic Foundations (Volume 6)

Setup

1. Install Docker
2. Make sure Docker is running
3. Install Visual Studio Code
4. Install Remote - Containers extension
5. Copy the .devcontainer folder to the root of your project folder

After following the above instructions open your project in Visual Studio Code and run the Remote-Containers: Reopen in Container command. If the instructions are followed correctly Visual Studio Code should also automatically suggest opening the repository in container mode when the project is loaded.

System requirements

See here

Known problems

VSCode shows Docker returned an error

Make sure that Docker is installed and running.

The Remote-Containers: Reopen in Container command is not recoqnized by VSCode

You need to have the Remote - Containers extension VSCode extension installed and enabled. See here for instructions on how to install it.

Running Remote-Containers: Reopen in Container cannot find container

Make sure you copied the .devcontainer folder to your projects root folder and that it includes the devcontainer.json file.

Cannot find a physical path bound to logical path X with prefix Y when importing file

• Make sure that the Coq files have been compiled. Run make to compile the project files.
• If the _CoqProject files is not located in the project root folder you need to either
  • Move the files to the root project folder
  • Or add the line "coq.coqProjectRoot": "PATH_TO_COQPROJECT" (in .devcontainer/devcontainer.json to point to the directory where _CoqProject is located. Restarting the docker container is required after this step.

Docker pull rate limit hit

Docker Hub rate limits pulls of images for free accounts to 200 per six hours. If this limit is hit you might get one of the following errors and have to wait until the rate limit resets.

• ERROR: toomanyrequests: Too Many Requests
• You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limits

FAQ

What is included in the Docker image?

The Docker image used for the devcontainer is built using the Dockerfile in this repository and hosted on Docker Hub. It is based on the coqorg/coq:8.15.2-ocaml-4.14.0-flambda image, which includes the following:

• Debian 11 Slim
• opam 2.1.2
• OCaml 4.14.0
• Coq 8.15.2
• coq-quickchick 1.6.1
• coq-ext-lib 0.11.6
• coq-equations 1.3+8.15