Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add defer CloseIntegrationTestEnv to e2e tests #1046

Open
11 tasks
0xivanov opened this issue Sep 3, 2024 · 2 comments · May be fixed by #1105
Open
11 tasks

Add defer CloseIntegrationTestEnv to e2e tests #1046

0xivanov opened this issue Sep 3, 2024 · 2 comments · May be fixed by #1105
Assignees
Labels
backlog enhancement New feature or request good first issue Issues which are ideal for a first time or new project contributor. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution.

Comments

@0xivanov
Copy link
Contributor

0xivanov commented Sep 3, 2024

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

  • Certain end-to-end (E2E) tests are not properly closing the testing environment after execution. This can lead to resource leaks and may affect the stability and reliability of subsequent tests.

Proposed Solution:

  • To ensure the testing environment is consistently closed, add a defer CloseIntegrationTestEnv() statement in all integration tests (specifically those ending with _e2e_test.go). This will automatically close the environment at the end of each test execution and delete the operator account.

  • However, if closing the environment causes a test failure, the environment should remain open to avoid interrupting the test flow. For these cases a follow up issue should be created, containing all the tests' names.

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
  • Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
  • You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

@0xivanov 0xivanov added enhancement New feature or request good first issue Issues which are ideal for a first time or new project contributor. good first issue candidate Issues that can become a good first issue but need more description/context. backlog and removed good first issue Issues which are ideal for a first time or new project contributor. labels Sep 3, 2024
@0xivanov 0xivanov added good first issue Issues which are ideal for a first time or new project contributor. and removed good first issue candidate Issues that can become a good first issue but need more description/context. labels Sep 26, 2024
@hendrikebbers hendrikebbers added the hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. label Oct 1, 2024
@RashRAJ
Copy link

RashRAJ commented Oct 2, 2024

I would like to work on this

@samswag
Copy link

samswag commented Oct 3, 2024

@RashRAJ sorry for the delay, you can go ahead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog enhancement New feature or request good first issue Issues which are ideal for a first time or new project contributor. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution.
Projects
None yet
4 participants