Add devcontainer.json for development with VS Code in a Docker container

[mkoeppe]

https://code.visualstudio.com/docs/remote/containers

We add two new sections in the developer's guide:
https://47f8b984ef964a5aa34147393fbdc32e0dde88ad--sagemath-tobias.netlify.app/developer/portability_testing.html#using-our-pre-built-docker-images-published-on-ghcr-io

We also set up devcontainer configurations for the CoCalc and computop/sage Docker images, as well as downstream distribution packaging of Sage.

• Cannot rebuild sage 3-manifolds/sagedocker#2

Tested devcontainer.json of

• portability-ubuntu-jammy-standard: builds well; runs well
• develop-docker-computop: builds well; runs well
• downstream-docker-cocalc: builds well; runs well (except machines with the issue Do not require AVX when building with SAGE_FAT_BINARY #32434)
• downstream-docker-computop: builds well; runs well
• downstream-archlinux-latest: builds well; runs well
• downstream-conda-forge-latest: builds well; runs well

Follow-ups:

• Installation guide: Document Sage installation on Windows via VS Code devcontainers #34363 Installation guide: Document installation on Windows via devcontainer
• Cookiecutter for Sage user projects with devcontainer #34286 Cookiecutter for Sage user projects with devcontainer
• .devcontainer/portability-ubuntu-jammy-standard fails in GitHub Codespaces #34403 GitHub Codespaces - may also be able to test it by starting a codespace at https:https://user-images.githubusercontent.com/5037600/216875765-6697bbf8-70f9-4acc-868e-9309db67be92.jpg/new?hide_repo_select=true&ref=public%2Fbuild%2Fdevcontainer&repo=302607352&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json
• downstream-* for more distributions (generate with tox from the info in tox.ini, use _sagemath` package)
• develop-conda-forge-src-environment-dev (https://doc.sagemath.org/html/en/installation/conda.html#using-conda-to-provide-all-dependencies-for-the-sage-library-experimental, similar to our gitpod configuration)
• Restore portability-debian-buster-i386-standard and fix it
• Restore develop-docker-cocalc (was: builds well (after increasing disk image space on the Docker daemon); fails to run)
• Restore - portability-centos-7-devtoolset-gcc_11-standard (was: builds well; fails to run (exactly the same on WSL))
• Restore downstream-docker-sagemath (after Update docker build #34242)
• add github workflows that verify that sage is at least compiling in these containers. That should be relatively straightforward using https://github.com/devcontainers/ci
• improve portability-Dockerfile as explained in comment:299

Depends on #33873
Depends on #34352

CC: @tobiasdiez @dimpase @williamstein @culler @saraedum @kwankyu

Component: user interface

Author: Tobias Diez, Matthias Koeppe, Kwankyu Lee

Branch/Commit: 4affef2

Reviewer: Kwankyu Lee, Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/33671

[mkoeppe]

Dependencies: #29536

[tobiasdiez]

Author: Tobias Diez

[tobiasdiez]

Commit: 85a7100

[tobiasdiez]

Changed dependencies from #29536 to none

[tobiasdiez]

Branch: public/build/devcontainer

[tobiasdiez]

comment:5

A basic devcontainer definition is now added for ubuntu systems.

---

New commits:

85a7100

Add devcontainer for ubuntu

[sagetrac-git]

Changed commit from 85a7100 to 11110ae

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

11110ae

Add bootstrap

[sagetrac-git]

Changed commit from 11110ae to c5295e3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

c5295e3

enable-build-as-root

[mkoeppe]

comment:9

Thanks! That's a beginning. Why do you not use the full build (-with-targets)?

[sagetrac-git]

Changed commit from c5295e3 to 872c0c8

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

58e112a	bootstrap-conda: Use script package _develop instead of hardcoded list of dev tools; remove unused RECOMMENDED
21e06c5	bootstrap-conda: Write an additional comment
4290b11	Add pytest-xdist package
a365828	build/pkgs/pytest/dependencies: Add missing dep
a2e396b	build/pkgs/pytest_xdist/dependencies: Add missing dep
2ec0061	Merge #33825
5857902	build/pkgs/_develop/dependencies: Add pytest, pytest_xdist
2368adc	bootstrap-conda: Write an additional comment (fixup)
0df31a9	bootstrap-conda: Rewrite using fewer redirects
872c0c8	.devcontainer: Generalize to other distros

[mkoeppe]

Changed author from Tobias Diez to Tobias Diez, Matthias Koeppe

[mkoeppe]

Dependencies: #33825

[mkoeppe]

Changed dependencies from #33825 to #33851

[sagetrac-git]

Changed commit from 872c0c8 to 96bb5ad

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

8d7f7ab	Merge #33851
96bb5ad	.devcontainer: Generalize to other distros

[tobiasdiez]

comment:14

Replying to @mkoeppe:

Thanks! That's a beginning. Why do you not use the full build (-with-targets)?

I didn't saw the point in that. In contrast to gitpod you don't know which version of sage the developer will use in the devcontainer, especially since devcontainer are cached by vscode until they are manually rebuild.

[mkoeppe]

comment:15

You also don't know that on gitpod, as I've explained in #33113 comment:18

[mkoeppe]

comment:294

OK

[tobiasdiez]

comment:295

Sorry Matthias, but the original version of the code was working well with codespaces. I'm happy you further worked on it, but it's not fair that you introduce issues with codespaces and then say "I don't care, lets fix them in a follow up ticket". And this is not for the sake of codespaces, but as I said above microsoft treats the codespaces as the defacto standard; so if its not working there then vscode will likely break in the future as well (and it will not work with other providers, such as devcontainer cli and gitpod). In fact, the vscode team works on using the same cli as codespaces, see microsoft/vscode-remote-release#6859 and microsoft/vscode-remote-release#7033.

So what about deleting the portability dockerfile completely, and simply specifying the image in the devcontainer? Since the dockerfile is simply forwarding to the github image anyway, this should suffice and be quicker. Moreover, can we use a different "target" that doesn't include the sage source code?

Finally, the names of the "post" scripts need to be changed and the docs changed to reflect the recent changes of "onCreateCommand" etc.

[kwankyu]

comment:296

Replying to @tobiasdiez:

... as I said above microsoft treats the codespaces as the defacto standard; so if its not working there then vscode will likely break in the future as well (and it will not work with other providers, such as devcontainer cli and gitpod). In fact, the vscode team works on using the same cli as codespaces,

Would you comment on: #34403 comment:3 ?

[mkoeppe]

comment:297

Replying to @tobiasdiez:

Sorry Matthias, but the original version of the code was working well with codespaces. I'm happy you further worked on it, but it's not fair that you introduce issues with codespaces and then say "I don't care, lets fix them in a follow up ticket".

I've set the scope of the ticket to be actionable. Work on codespaces is not actionable for me. You want to support them, you do the work on the follow-up ticket.

[sagetrac-git]

Changed commit from d5610b1 to 179406f

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

179406f

src/doc/en/developer/portability_testing.rst: Update references to devcontainer ...Command

[mkoeppe]

comment:299

Replying to @tobiasdiez:

So what about deleting the portability dockerfile completely

It's there as preparation for the following improvement (which is waiting for #29536):

• always pull FROM the build stage -with-system-packages
• then COPY the Sage SAGE_LOCAL (but not the old Sage source tree) from the requested build stage such as the default -with-targets
  This creates a smaller version of the container image.

[sagetrac-git]

Changed commit from 179406f to 4affef2

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

4affef2

.devcontainer/onCreate.sh, portability-updateContent.sh: Rename from post_create.sh, portability-post_start.sh

[mkoeppe]

comment:302

Replying to @tobiasdiez:

the names of the "post" scripts need to be changed and the docs changed to reflect the recent changes of "onCreateCommand" etc.

Thanks for catching this. Done now.

[kwankyu]

comment:304

Simple renaming. Positive again.

[vbraun]

Changed branch from public/build/devcontainer to 4affef2