Skip to content

Files

Latest commit

 

History

History
80 lines (55 loc) · 3.8 KB

README.md

File metadata and controls

80 lines (55 loc) · 3.8 KB

Development with DevContainer (VS Code)

Back to main README

When using a DevContainer, the opam packages and database files are mounted as volumes into the DevContainer.

  • Docker volume db-root: development mariadb data (root)
  • Docker volume db-tenant: development mariadb data (tenants)
  • Docker volume opam: opam packages
  • Docker volume build: cached build directory to speed up development

Requirements

This project is setup to run in a DevContainer. Ensure requirements to run in a DevContainer:

  1. Git installed
  2. Source Tree for GitLab setup (see Install user interface and Configure GitLab for Source Tree)
  3. Docker installed
  4. Visual Studio Code (VS Code) installed
  5. VS Code Extension Remote Container installed

Your SSH folder and Git config gets mapped to the container. You should be able to use SSH and Git inside the container. Please ensure ~/.gitconfig doesn't contain absolute paths (you may use the ~ profile prefix, i.e. excludesfile = ~/.gitignore_global). Please note: You probably have to update Sourcetree settings. In its settings "General" tab uncheck "Allow Sourcetree to modify your global Mercurial and Git configuration files".

Start

If needed, edit .devcontainer/docker-compose.override.yml to suit your needs.

Click on the icon similar to "><" in the bottom left corner and select Remote-Containers: Reopen in Container. If any changes were made to files in .devcontainer folder the Container should be rebuilt (Remote-Containers: Rebuild Container)

NOTE: When the setup is fully installed, select View -> Command Palette... and run the command OCaml: Restart Language Server

Running Dev Container

  • The Makefile used in the DevContainer is located in the .devcontainer folder
  • Ports from outside (e.g. localhost)
    • webserver
      • root 3016
      • tenant 3017
    • database
      • root3316
      • tenant 3317

Running Tests with Dev Container

  1. Create a .env.test file
  2. Add the following variables to it
    • DATABASE_URL=mariadb://root@database-root:3306/test
    • MYSQL_DATABASE=test_econ
  3. Prepare test database (migration/seeds) and run the tests
    • make test-clean

Database View

There is an Adminer container added to the development package. To be able to use it, follow these few steps:

  1. Uncomment its line in the .devcontainer/devcontainer.json under runServices
  2. Use Remote-Containers: Rebuild Container that it will also create and startup the Adminer container
  3. Open your web browser and open localhost:8080

Troubleshooting

"Go-to-definition" opens Capitalized File

This behaviour is related to the ocaml-lsp-server (as a first impression), when using a ritght click on a function name and selecting "Go to Definition" it jumps to the capitalized filename instead of the correct and existing (in our case lowercased) filename.

Solution

This issue isn't related to ocaml-lsp-server it's depending on the underliing format of your data volume and it's ability to handle case sensitivity (link for MacOS and Windows WSL).

MacOS
  • Create a "Case-Sensitive" volume
  • Clone the project on the new volume
  • Delete all currently existing Container/Images/Volumes related to the pool tool
  • Open the newly cloned project in VSCode
  • Use "Reopen in Container"