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

More Readable Gradle test config. #18890

Merged
merged 5 commits into from
Nov 3, 2022
Merged

Conversation

davinchia
Copy link
Contributor

@davinchia davinchia commented Nov 3, 2022

What

The integration testing logs are extremely noisy today. The logs contain the entire test STDOUT and are a pain to read.

This PR contains a better test setup config to reduce logging output.

How

  • The main change is to comment out ShowStandardStreams in the integration tests plugin.
  • Then we add the started event so Gradle shows us when a test is started. Some tests take a longer time. It is useful to know they have begun so it's clear if the job is stuck or not.
  • Standardise the above setting across all of our custom test tasks.

Recommended reading order

The two files.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@davinchia davinchia temporarily deployed to more-secrets November 3, 2022 04:43 Inactive
@davinchia davinchia changed the title Best Gradle test config. More Readable Gradle test config. Nov 3, 2022
@davinchia davinchia marked this pull request as ready for review November 3, 2022 04:44
@davinchia davinchia temporarily deployed to more-secrets November 3, 2022 04:46 Inactive
@davinchia
Copy link
Contributor Author

With ShowStandardStreams turned on, we see something like https://github.com/airbytehq/airbyte/actions/runs/3382195729/jobs/5616889435#step:12:7156 - STDOUT from running the tests is going to the log file.

@davinchia
Copy link
Contributor Author

By removing ShowStandardStreams, we get a much more concise test view instead https://github.com/airbytehq/airbyte/actions/runs/3383069551/jobs/5618641819#step:12:773.

By adding the started event, it is clear to a dev when something is started.

@davinchia
Copy link
Contributor Author

thank you @jdpgrailsdev for the tip!

@davinchia davinchia requested a review from gosusnp November 3, 2022 05:15
Copy link
Contributor

@jdpgrailsdev jdpgrailsdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants