Refactor: Test Framework and Update Docker Compose Configuration by rohansx · Pull Request #701 · xline-kv/Xline

rohansx · 2024-03-17T16:41:42Z

Key Changes:

Created a new docker-compose.yml file to manage the Xline cluster configuration, ensuring all services are correctly networked and equipped with the necessary volumes, ports, and environment settings.
Refactored the validation.sh script to utilize Docker Compose for starting and stopping services, aligning it with the new docker-compose.yml configuration. This update simplifies the validation process and ensures compatibility with the Docker Compose setup.
Updated the benchmark.sh and quick_start.sh documentation to reflect the new Docker Compose-based approach. This includes instructions on how to use the docker-compose file for setting up a development or testing environment and guidelines for executing validation and benchmark tests.

These changes aim to streamline the project's testing framework, reduce redundancy, and improve the overall developer experience when testing and validating the Xline cluster's functionality.

Resolves: #692

Signed-off-by: rohansx <sharmarohan615@gmail.com>

Signed-off-by: ChaudharyRaman <ramanchaudhary2704@gmail.com> Signed-off-by: rohansx <sharmarohan615@gmail.com>

Signed-off-by: rohansx <sharmarohan615@gmail.com>

rohansx · 2024-03-17T16:42:38Z

@Phoenix500526 Pleaase review this PR and let me know the changes and then I'll proceed with the documentation

codecov · 2024-03-18T01:32:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.16%. Comparing base (eadf2d9) to head (eaea991).
⚠️ Report is 342 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #701      +/-   ##
==========================================
- Coverage   75.17%   75.16%   -0.02%     
==========================================
  Files         176      176              
  Lines       26852    26852              
  Branches    26852    26852              
==========================================
- Hits        20187    20183       -4     
- Misses       5452     5454       +2     
- Partials     1213     1215       +2

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ner for interaction Signed-off-by: rohansx <sharmarohan615@gmail.com>

rohansx · 2024-03-21T04:08:48Z

@liangyuanpeng adjusted port configurations for xLine nodes and added client container for enhanced interaction. @Phoenix500526 updated node2 and node3 ports to avoid special port conflicts and included --client-listen-urls and --peer-listen-urls for clearer networking. Also added a client service for testing and interaction purposes.

Phoenix500526

Please rebase this pr.

Signed-off-by: rohansx <sharmarohan615@gmail.com>

rohansx · 2024-03-21T13:58:43Z

@Phoenix500526 I have done the necessary modification as you mentioned above. I updated client container image for CI validation process to ghcr.io/xline-kv/etcdctl:v3.5.9

Phoenix500526 · 2024-03-22T01:34:49Z

There are still some problems with the validation CI. Please fix them so that this pr can pass the CI. You can run the validation on your local via executing scripts/validation_test.sh.

rohansx · 2024-03-22T14:32:07Z

There are still some problems with the validation CI. Please fix them so that this pr can pass the CI. You can run the validation on your local via executing scripts/validation_test.sh.

working on this.

Signed-off-by: rohansx <sharmarohan615@gmail.com>

Signed-off-by: Phoeniix Zhao <Phoenix500526@163.com>

Signed-off-by: rohansx <sharmarohan615@gmail.com>

Phoenix500526 · 2024-03-25T01:11:04Z

There are several issues in this pr:

please add a signed-off-by information in your commits.
please format the commit message. The commit message "�[200~Refactor Test Framework and Update..." is invalid.
The validation CI is still not pass. It seems the relevant container created by docker-compose named "ci-client-1", not client.

rohansx · 2024-03-30T18:35:50Z

@Phoenix500526 @liangyuanpeng , I am encountering a validation check error, and I have tried to resolve it without success. Could you please explain why this validation check is failing and provide guidance on how I can address the issue?

Phoenix500526 · 2024-03-31T12:30:45Z

@@ -0,0 +1,85 @@
+version: "3.9"


The version is obsolete, please remove this line. FYI: mailcow/mailcow-dockerized#5797

Phoenix500526 · 2024-03-31T13:08:49Z

+
+services:
+  node1:
+    image: ghcr.io/xline-kv/xline:latest


Please add container_name to specify the container name.

Phoenix500526 · 2024-03-31T13:09:02Z

+      --peer-listen-urls http://172.22.0.2:2380
+
+  node2:
+    image: ghcr.io/xline-kv/xline:latest


Same as above.

Phoenix500526 · 2024-03-31T13:09:14Z

+      --peer-listen-urls http://172.22.0.3:2380
+
+  node3:
+    image: ghcr.io/xline-kv/xline:latest


Same as above

Phoenix500526 · 2024-03-31T13:09:21Z

+      --peer-listen-urls http://172.22.0.4:2380
+
+  client:
+    image: ghcr.io/xline-kv/etcdctl:v3.5.9


Same as above

Phoenix500526 · 2024-03-31T13:10:34Z

+    driver: bridge
+    ipam:
+      config:
+        - subnet: "172.22.0.0/16"


Please keep this subnet unify with the subnet in validation_test.sh

Phoenix500526 · 2024-03-31T13:29:26Z

@Phoenix500526 @liangyuanpeng , I am encountering a validation check error, and I have tried to resolve it without success. Could you please explain why this validation check is failing and provide guidance on how I can address the issue?

I think there are several reasons behind this validation failure:

The docker-compose will generate a default name for those containers without specifying their container_name. In this case, the name of the client container is ci-client-1, not client. Hence, the validation test will get an error like "No such container named client"
In this pr, you changed the subnet from 172.20.0.0/16 to 172.22.0.0/16, but you forgot to update the ip address in the validation_test.sh.
The original quick_start.sh mounts ./scripts to /mnt and the validation_test.sh uses the ./scripts/validation_lock_client to do some test stuff.

Finally, please modify our quick start doc to make it unify with the code change in this pr. Thanks 😄

Phoenix500526 · 2024-04-24T01:02:38Z

Hi, @rohansx ! This pr has been stalled for 3 weeks. Would you like to update it? 😄

rohansx · 2024-04-24T17:41:00Z

Hi, @rohansx ! This pr has been stalled for 3 weeks. Would you like to update it? 😄

@Phoenix500526 yes I'll update in the next week.. sorry for the delay.. actually kind of looking for a job and got stuck in the interview process and therefore i couldn't look into it..

Phoenix500526 · 2024-05-16T12:56:05Z

@Mergifyio rebase

mergify · 2024-05-16T12:56:16Z

rebase

❌ Base branch update has failed

Details

Git reported the following error:

Rebasing (1/14)
Auto-merging scripts/quick_start.sh
CONFLICT (content): Merge conflict in scripts/quick_start.sh
Auto-merging scripts/validation_test.sh
CONFLICT (content): Merge conflict in scripts/validation_test.sh
error: could not apply ffc737c... ?[200~Refactor Test Framework and Update Docker Compose Configuration
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply ffc737c... �[200~Refactor Test Framework and Update Docker Compose Configuration

mergify · 2024-05-20T01:57:36Z

@rohansx Your PR is in conflict and cannot be merged.

rohansx and others added 9 commits March 17, 2024 00:15

�[200~Refactor Test Framework and Update Docker Compose Configuration

15fb14c

Merge branch 'master' of https://github.com/rohansx/Xline

d9607f9

�[200~Refactor Test Framework and Update Docker Compose Configuration

ffc737c

Signed-off-by: rohansx <sharmarohan615@gmail.com>

Refactor: Test Framework and Update Docker Compose Configuration

4139b87

fix: quick-start readme corrected pem file path

6817913

Signed-off-by: ChaudharyRaman <ramanchaudhary2704@gmail.com> Signed-off-by: rohansx <sharmarohan615@gmail.com>

Merge branches 'master' and 'master' of https://github.com/rohansx/Xline

96134ac

fix: trailing space and bug

c32cfa1

fix: trailing space and bug

ce9bfe1

Signed-off-by: rohansx <sharmarohan615@gmail.com>

feat: test framework and update docker compose configuration

20d686f

Signed-off-by: rohansx <sharmarohan615@gmail.com>

rohansx changed the title ~~Refacot: Test Framework and Update Docker Compose Configuration~~ Refactor: Test Framework and Update Docker Compose Configuration Mar 17, 2024

liangyuanpeng reviewed Mar 19, 2024

View reviewed changes

Comment thread ci/docker-compose.yml Outdated

Comment thread ci/docker-compose.yml Outdated

Phoenix500526 reviewed Mar 20, 2024

View reviewed changes

Comment thread ci/docker-compose.yml

Comment thread ci/docker-compose.yml

rohansx and others added 3 commits March 21, 2024 09:28

fix: adjust port configurations for xLine nodes and add client contai…

71e827a

…ner for interaction Signed-off-by: rohansx <sharmarohan615@gmail.com>

Merge branch 'xline-kv:master' into master

d6c0471

Merge branch 'test-framework'

dd385cc

Phoenix500526 reviewed Mar 21, 2024

View reviewed changes

Comment thread ci/docker-compose.yml Outdated

fix: update client container image for CI validation process

c183c2e

Signed-off-by: rohansx <sharmarohan615@gmail.com>

rohansx and others added 7 commits March 24, 2024 17:06

fix: fix port number for node2

71c19af

fix: fix port number for node3

edd7f22

Merge branch 'xline-kv:master' into master

81a22ae

fix: fix port number for node2

702d34b

Signed-off-by: rohansx <sharmarohan615@gmail.com>

chore: mount LOG_PATH as xline container log dir

55b0158

Signed-off-by: Phoeniix Zhao <Phoenix500526@163.com>

fix: trailing space and bug

33203c3

fix: trailing space and bug

95ae436

Signed-off-by: rohansx <sharmarohan615@gmail.com>

Merge branch 'xline-kv:master' into master

eaea991

Phoenix500526 reviewed Mar 31, 2024

View reviewed changes

mergify Bot requested a review from a team April 19, 2024 04:36

Conversation

rohansx commented Mar 17, 2024

Uh oh!

rohansx commented Mar 17, 2024

Uh oh!

codecov Bot commented Mar 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rohansx commented Mar 21, 2024

Uh oh!

Phoenix500526 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rohansx commented Mar 21, 2024

Uh oh!

Phoenix500526 commented Mar 22, 2024

Uh oh!

rohansx commented Mar 22, 2024

Uh oh!

Phoenix500526 commented Mar 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rohansx commented Mar 30, 2024

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 Mar 31, 2024

Choose a reason for hiding this comment

Uh oh!

Phoenix500526 commented Mar 31, 2024

Uh oh!

Phoenix500526 commented Apr 24, 2024

Uh oh!

rohansx commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Phoenix500526 commented May 16, 2024

Uh oh!

mergify Bot commented May 16, 2024

❌ Base branch update has failed

Uh oh!

mergify Bot commented May 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Mar 18, 2024 •

edited

Loading

Phoenix500526 commented Mar 25, 2024 •

edited

Loading

rohansx commented Apr 24, 2024 •

edited

Loading