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

Make the test timeout a configurable value #237

Open
11 tasks
rwalworth opened this issue Sep 5, 2024 · 1 comment
Open
11 tasks

Make the test timeout a configurable value #237

rwalworth opened this issue Sep 5, 2024 · 1 comment
Assignees
Labels
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. help wanted Extra attention is needed

Comments

@rwalworth
Copy link
Contributor

rwalworth commented Sep 5, 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

Currently, tests are hardcoded to timeout after 30 seconds. This should be made a configurable value.

Proposed Solution

  1. Add a TEST_TIMEOUT configuration value to the .env.custom_node and .env.testnet files that allows a user to control how quickly a test should timeout.
  2. Make necessary code changes to pull in this value and set it for all test suites. This includes all *.js files under the test/ directory. A describe block is used to demarcate the tests for a specific request type and within the describe block, there should be a this.timeout(30000); line or something to that effect. This is what specifies the timeout for tests. If no value is provided, a default value (30) should be used.
  3. Verify the timeout. Follow the directions in the README to start an SDK server and configure the TCK to run with the hedera-local-node and run it. Change the NODE_IP value in your .env file to use a different port and set TEST_TIMEOUT to 2000. Run the TCK using npm test run and observe the tests failing after 2 seconds. You should be able to then change the value to 3000 to see the tests failing after 3 seconds.

📋 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.

@rwalworth rwalworth added enhancement New feature or request good first issue candidate Issues that can become a good first issue but need more description/context. labels Sep 5, 2024
@hendrikebbers hendrikebbers added help wanted Extra attention is needed 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. and removed good first issue candidate Issues that can become a good first issue but need more description/context. labels Sep 30, 2024
@DevvEmeka
Copy link

I am interested in working on the issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants