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

Tweetest Prep work for jacoco tests #2432

Closed
10 tasks
smlambert opened this issue Mar 31, 2021 · 3 comments · Fixed by #2538
Closed
10 tasks

Tweetest Prep work for jacoco tests #2432

smlambert opened this issue Mar 31, 2021 · 3 comments · Fixed by #2538
Assignees
Labels
docs good first issue type:external 3rd party application tests (invoked by the make target 'external')
Milestone

Comments

@smlambert
Copy link
Contributor

smlambert commented Mar 31, 2021

👾 Description of the issue

We run external third-party application tests at this project. They are contained within the external directory. We would like to improve how we run these tests. The first step to improving how we run them is to add some documentation and to pull out the individual test properties that we use so that they are stored in the same directory as the test.

This issue is to add a README.md and a test.properties file to the /external/jacoco test directory. As part of this prep work, since we already generate the Dockerfile, please also remove the static https://github.com/AdoptOpenJDK/openjdk-tests/blob/master/external/jacoco/dockerfile/Dockerfile.

The contents of the README file can be simply some instructions for how to run the test locally. Use with the instructions from https://github.com/AdoptOpenJDK/openjdk-tests/blob/master/external/README.md#running-external-tests-locally and modify Steps 7 and 9 to reference jacoco and jacoco_test specifically.

The contents of the test.properties file will be a key=value format, copying the information from https://github.com/AdoptOpenJDK/openjdk-tests/blob/master/external/common_functions.sh#L239-L251 to populate it.

Adding these files will not change the current way we run these tests. A separate change will be made to reference the test.properties file, at which point the contents must match those in the common_functions.sh script.

Please take the time to try and run the test locally (using the instructions you are adding in the README file). Some of the external tests are failing. When you run it locally, you may find that to be the case. The reviewer can help to advise you if there are any further steps you can take to try and debug the pre-existing failure, if it exists.

📋 Step by Step

To solve this issue and contribute a fix you should check the following step-by-step list. A more detailed documentation of the workflow can be found here. Note: that you do not need to add yourself to a Contributors.md file as outlined in the detailed instructions.

  • Claim this issue: Comment below.
  • Fork the repository in github by simply clicking the 'fork' button.
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have any naming definition for branches.
  • Commit your changes.
  • Start a Pull Request.
  • Done 👍 Ask in comments for a review :)
  • If the reviewer find some missing pieces or a problem they will start a discussion with you and describe the next steps how the problem can be solved.
  • You did it 🎉 We will merge the fix in the master branch.
  • Thanks, thanks, thanks for being part of this project as an open source contributor ❤️

🤔❓ Questions

If you have any questions just ask us directly in this issue by adding a comment. You can join our community chat at Slack. Next to this you can find a general manual about open source contributions here.

@smlambert smlambert added docs good first issue type:external 3rd party application tests (invoked by the make target 'external') labels Mar 31, 2021
@smlambert smlambert changed the title Add README.md and test.properties file to /external/jacoco directory Tweetest Prep work for jacoco tests Mar 31, 2021
@mara-ber
Copy link
Contributor

mara-ber commented Apr 2, 2021

Hi I'm an Outreachy applicant, can I try working on this issue?

@smlambert
Copy link
Contributor Author

Definitely! Welcome @mara-ber ! If you have any questions, please feel free to ask them in this issue. :)

@karianna karianna added this to the April 2021 milestone Apr 6, 2021
@mara-ber
Copy link
Contributor

Hi! Could someone take a look at PR, please?
#2538

I know it took too long to get it done and I'm not sure it's done properly. I have no experience with JDK tests and required environment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs good first issue type:external 3rd party application tests (invoked by the make target 'external')
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants