feat: support devcontainer #11765

bzp2010 · 2024-11-21T06:15:23Z

Description

Add devcontainer support to the project, which is expected to cover Linux, Windows (WSL2), macOS OSs, and the amd64, arm64 CPU ISAs, i.e. the environments used by most developers.

Basically, the container provides an isolated environment from the host, the runtime and toolset required for APISIX development are built in the container build, they will be available out of the box and developers no longer need to build and install them on the host. Just start dev container, wait a few moments, and it's ready to go.

Significantly simplify the parts that may be unfamiliar to developers and just focus on writing Lua code and test cases.

In addition to this, etcd is ready, maintained by docker-compose, and accessible on the local loopback.

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

bzp2010 · 2024-11-21T09:17:09Z

I have tested this on Windows WSL2 + Docker Desktop and macOS + OrbStack, where macOS is an arm64 based m4 chip.
Developers don't need to make any individual adjustments to any of the above environments, they will automatically do the right thing. (e.g. Installs the arm64-based binaries)

However, I don't have a desktop system running Linux, which would require someone else to help test, but that should not be a problem.

bzp2010 · 2024-11-21T09:19:34Z

The error in the CI is not related to this PR, it also fails on other PRs, will investigate it later.

UPDATE

I have fixed the issue in #11769.

SkyeYoung · 2024-11-22T06:44:51Z

🆒 I will help with testing using Manjaro KDE Plasma(amd64) + Docker Engine.

SkyeYoung · 2024-11-22T08:02:55Z

Tested in Manjaro KDE Plasma (amd64) + Docker Engine:

But I encountered some problems during the test:

Error Log

error.log

github-actions · 2025-02-06T10:05:14Z

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.

.devcontainer/docker-compose.yml

bzp2010 · 2025-03-20T05:09:35Z

This PR has been renovated, where the tests can run correctly, except for a problem that needs to be solved by #12070.

SkyeYoung · 2025-03-21T13:46:27Z

This PR has been renovated, where the tests can run correctly, except for a problem that needs to be solved by #12070.

Looks like #12070 has been merged.

bzp2010 · 2025-03-30T13:52:14Z

Merging the master branch to fix #12070 doesn't seem to be successful, I'll rebase and force push.

Co-authored-by: SkyeYoung <iskyex@outlook.com>

SkyeYoung · 2025-03-31T13:57:32Z

~~Still got some error logs:~~ It seems that there will be many problems caused by personal environmental factors

🤔

SkyeYoung · 2025-03-31T14:01:02Z

.devcontainer/Dockerfile

+    && rm -f /tmp/etcd-${ETCD_VER}-linux-amd64.tar.gz && rm -rf /tmp/etcd-download-test \
+    && rm -rf /tmp/*


maybe u can use rm -rf dir1 dir2 ...

SkyeYoung · 2025-03-31T14:03:04Z

.devcontainer/devcontainer.json

+  "service": "apisix",
+  "workspaceFolder": "/workspace",
+  "privileged": true,
+  "postCreateCommand": "bash -c 'cd /workspace && rm -rf test-nginx && git config --global --add safe.directory /workspace && git submodule update --init --recursive && git clone https://github.com/openresty/test-nginx.git --depth 1 && make deps'",


u can try sth like git clone --depth 1 --single-branch --branch main

SkyeYoung · 2025-03-31T14:47:13Z

docs/en/latest/build-apisix-dev-environment-devcontainers.md

+
+:::
+
+Wait some minutes, depending on the internet connection or computer performance, it may take from a few minutes to tens of minutes, you can click on the Progress Bar in the bottom right corner to view a live log where you will be able to check unusual stuck.


Suggested change

Wait some minutes, depending on the internet connection or computer performance, it may take from a few minutes to tens of minutes, you can click on the Progress Bar in the bottom right corner to view a live log where you will be able to check unusual stuck.

Wait some minutes, depending on the internet connection or computer performance, it may take from a few minutes to tens of minutes, you can click on the Progress Bar in the bottom right corner to view a live log where you will be able to check unusual stuck.

If you encounter any problems, you can search or ask questions in [GitHub Issues](https://github.com/apache/apisix/issues) or [GitHub Discussions](https://github.com/apache/apisix/discussions), and community members will respond as promptly as possible.

SkyeYoung · 2025-03-31T14:50:13Z

docs/en/latest/build-apisix-dev-environment-devcontainers.md

+make test
+
+# or run a specify test case file
+TEST_NGINX_BINARY=openresty FLUSH_ETCD=1 prove -Itest-nginx/lib -I. -r t/admin/api.t


Suggested change

make test

# or run a specify test case file

TEST_NGINX_BINARY=openresty FLUSH_ETCD=1 prove -Itest-nginx/lib -I. -r t/admin/api.t

export TEST_NGINX_BINARY=openresty

# run all tests

make test

# or run a specify test case file

FLUSH_ETCD=1 prove -Itest-nginx/lib -I. -r t/admin/api.t

make test requires TEST_NGINX_BINARY.

SkyeYoung · 2025-03-31T14:51:16Z

docs/en/latest/build-apisix-dev-environment-devcontainers.md

+
+It will be on your host, which is where you cloned the APISIX source code, and the container uses the volume to mount the code into the container. Containers contain only the runtime environment, not the source code, so no changes will be lost whether you close or delete the container.
+
+And, the git is already installed in the container, so you can commit a change directly there.


Suggested change

And, the git is already installed in the container, so you can commit a change directly there.

And, the `git` is already installed in the container, so you can commit a change directly there.

bzp2010 force-pushed the bzp/feat-devcontainer branch from 5533908 to 44bc599 Compare November 21, 2024 12:43

bzp2010 requested review from juzhiyuan, yzeng25, kayx23, pottekkat and guoqqqi November 22, 2024 04:48

bzp2010 marked this pull request as ready for review November 22, 2024 04:48

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Nov 22, 2024

bzp2010 requested a review from SkyeYoung November 22, 2024 06:19

github-actions bot added the stale label Feb 6, 2025

bzp2010 removed the stale label Mar 16, 2025

SkyeYoung requested changes Mar 17, 2025

View reviewed changes

.devcontainer/docker-compose.yml Outdated Show resolved Hide resolved

bzp2010 requested a review from SkyeYoung March 17, 2025 04:40

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Mar 30, 2025

bzp2010 added 6 commits March 30, 2025 22:15

feat: support devcontainer for dev

0a6bd0f

fix: license header

233ccc2

feat: add test-nginx toolchain

016c087

feat: support devcontainer for dev

bb3d385

fix: license header

d1b714b

feat: add test-nginx toolchain

5f68ef5

bzp2010 and others added 6 commits March 30, 2025 22:15

fix

2684fac

docs

cc6bca1

fix: eclint

e700eff

docs: add progress bar tips

d5d6d3f

fix: zombie processes when testing

9c1812d

Update .devcontainer/docker-compose.yml

183ad13

Co-authored-by: SkyeYoung <iskyex@outlook.com>

bzp2010 force-pushed the bzp/feat-devcontainer branch from cf3b2f4 to 183ad13 Compare March 30, 2025 14:40

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Mar 30, 2025

SkyeYoung reviewed Mar 31, 2025

View reviewed changes

Baoyuantop added this to ⚡️ Apache APISIX Roadmap Apr 1, 2025

Baoyuantop moved this to 👀 In review in ⚡️ Apache APISIX Roadmap Apr 1, 2025

fix comments

80399ed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support devcontainer #11765

feat: support devcontainer #11765

bzp2010 commented Nov 21, 2024 •

edited

Loading

bzp2010 commented Nov 21, 2024

bzp2010 commented Nov 21, 2024 •

edited

Loading

SkyeYoung commented Nov 22, 2024

SkyeYoung commented Nov 22, 2024 •

edited

Loading

github-actions bot commented Feb 6, 2025

bzp2010 commented Mar 20, 2025

SkyeYoung commented Mar 21, 2025

bzp2010 commented Mar 30, 2025

SkyeYoung commented Mar 31, 2025 •

edited

Loading

SkyeYoung Mar 31, 2025

SkyeYoung Mar 31, 2025

SkyeYoung Mar 31, 2025

SkyeYoung Mar 31, 2025

SkyeYoung Mar 31, 2025

		&& rm -f /tmp/etcd-${ETCD_VER}-linux-amd64.tar.gz && rm -rf /tmp/etcd-download-test \
		&& rm -rf /tmp/*


		:::

		Wait some minutes, depending on the internet connection or computer performance, it may take from a few minutes to tens of minutes, you can click on the Progress Bar in the bottom right corner to view a live log where you will be able to check unusual stuck.


		It will be on your host, which is where you cloned the APISIX source code, and the container uses the volume to mount the code into the container. Containers contain only the runtime environment, not the source code, so no changes will be lost whether you close or delete the container.

		And, the git is already installed in the container, so you can commit a change directly there.

	And, the git is already installed in the container, so you can commit a change directly there.
	And, the `git` is already installed in the container, so you can commit a change directly there.

feat: support devcontainer #11765

Are you sure you want to change the base?

feat: support devcontainer #11765

Conversation

bzp2010 commented Nov 21, 2024 • edited Loading

Description

Checklist

bzp2010 commented Nov 21, 2024

bzp2010 commented Nov 21, 2024 • edited Loading

UPDATE

SkyeYoung commented Nov 22, 2024

SkyeYoung commented Nov 22, 2024 • edited Loading

github-actions bot commented Feb 6, 2025

bzp2010 commented Mar 20, 2025

SkyeYoung commented Mar 21, 2025

bzp2010 commented Mar 30, 2025

SkyeYoung commented Mar 31, 2025 • edited Loading

SkyeYoung Mar 31, 2025

Choose a reason for hiding this comment

SkyeYoung Mar 31, 2025

Choose a reason for hiding this comment

SkyeYoung Mar 31, 2025

Choose a reason for hiding this comment

SkyeYoung Mar 31, 2025

Choose a reason for hiding this comment

SkyeYoung Mar 31, 2025

Choose a reason for hiding this comment

bzp2010 commented Nov 21, 2024 •

edited

Loading

bzp2010 commented Nov 21, 2024 •

edited

Loading

SkyeYoung commented Nov 22, 2024 •

edited

Loading

SkyeYoung commented Mar 31, 2025 •

edited

Loading