feat: support devcontainer by bzp2010 · Pull Request #11765 · apache/apisix

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 [email protected] list. Thank you for your contributions.

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 <[email protected]>

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

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

🤔

Baoyuantop

Works well on my arm macOS.

Baoyuantop · 2025-05-07T06:41:28Z

+
+:::note
+
+The following uses Visual Studio Code, which has built-in integration with Dev Containers.


Need to install the Dev Containers extension?

@Baoyuantop Yes

Usually, it is pre-included. I mentioned that "which has built-in integration"

bzp2010 · 2025-05-17T16:38:04Z

I confirmed that the test failure is not related to this PR, so maybe we can merge this PR first and continue to improve usability in subsequent PRs. This PR has been open for too long.

Co-authored-by: YYYoung <[email protected]>

juzhiyuan

I have tried locally and works well

SkyeYoung

I tried it again locally, and it is still the previous environment.

make run and FLUSH_ETCD=1 prove -Itest-nginx/lib -I. -r t/admin/api.t works.

But make test still have some problems.

bzp2010 · 2025-06-01T06:28:23Z

@juzhiyuan @SkyeYoung

These warnings will be fixed in a later PR. I will merge this PR first.

Co-authored-by: SkyeYoung <[email protected]>

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

bzp2010 requested review from guoqqqi, juzhiyuan, kayx23, pottekkat and yzeng25 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

Comment thread .devcontainer/docker-compose.yml Outdated

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 <[email protected]>

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

Comment thread .devcontainer/Dockerfile Outdated

SkyeYoung reviewed Mar 31, 2025

View reviewed changes

Comment thread .devcontainer/devcontainer.json Outdated

SkyeYoung reviewed Mar 31, 2025

View reviewed changes

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

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

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

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

Baoyuantop reviewed May 7, 2025

View reviewed changes

bzp2010 and others added 2 commits May 18, 2025 00:39

follow suggestion from @SkyeYoung

c1a597f

Co-authored-by: YYYoung <[email protected]>

Apply suggestions from @SkyeYoung

b6b474b

Co-authored-by: YYYoung <[email protected]>

bzp2010 requested review from Baoyuantop and SkyeYoung May 17, 2025 16:40

Baoyuantop approved these changes May 19, 2025

View reviewed changes

juzhiyuan approved these changes May 21, 2025

View reviewed changes

SkyeYoung approved these changes May 27, 2025

View reviewed changes

bzp2010 merged commit f1630d2 into apache:master Jun 1, 2025

github-project-automation Bot moved this from 👀 In review to ✅ Done in ⚡️ Apache APISIX Roadmap Jun 1, 2025

laz-xyr pushed a commit to laz-xyr/apisix that referenced this pull request Jun 19, 2025

feat: support devcontainer (apache#11765)

e36aba2

Co-authored-by: SkyeYoung <[email protected]>


		:::note

		The following uses Visual Studio Code, which has built-in integration with Dev Containers.

Uh oh!

Conversation

bzp2010 commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

bzp2010 commented Nov 21, 2024

Uh oh!

bzp2010 commented Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

UPDATE

Uh oh!

SkyeYoung commented Nov 22, 2024

Uh oh!

SkyeYoung commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Feb 6, 2025

Uh oh!

Uh oh!

bzp2010 commented Mar 20, 2025

Uh oh!

SkyeYoung commented Mar 21, 2025

Uh oh!

bzp2010 commented Mar 30, 2025

Uh oh!

SkyeYoung commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Baoyuantop left a comment

Choose a reason for hiding this comment

Uh oh!

Baoyuantop May 7, 2025

Choose a reason for hiding this comment

Uh oh!

bzp2010 May 17, 2025

Choose a reason for hiding this comment

Uh oh!

bzp2010 May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bzp2010 commented May 17, 2025

Uh oh!

juzhiyuan left a comment

Choose a reason for hiding this comment

Uh oh!

SkyeYoung left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bzp2010 commented Jun 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

bzp2010 May 17, 2025 •

edited

Loading

SkyeYoung left a comment •

edited

Loading