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

MQTT Destination: Password is not marked as a secret field in spec #16263

Merged
merged 15 commits into from
Sep 7, 2022

Conversation

alexandr-shegeda
Copy link
Contributor

What

The password field of the MQTT destination is not marked as a secret field in the connector specification and thus this field will not show correctly as a password field in the CI, which leads to several potential security drawbacks.

How

Marked the password field in spec as secret

Recommended reading order

  1. spec.json

🚨 User Impact 🚨

No user impact

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.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Sep 2, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

/test connector=connectors/destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 2, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2978651876
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2978651876
🐛 https://gradle.com/s/a4vg6s2wkcwtc

Build Failed

Test summary info:

Could not find result summary

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@DoNotPanicUA DoNotPanicUA removed their assignment Sep 5, 2022
@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 5, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2992868680
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2992868680
🐛 https://gradle.com/s/ppyxvtrwocmqg

Build Failed

Test summary info:

Could not find result summary

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 5, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2995148966
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2995148966
🐛 https://gradle.com/s/atq3stbi5tt6g

Build Failed

Test summary info:

Could not find result summary

@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 6, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2999695196
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2999695196
🐛 https://gradle.com/s/6wvjqnzjiavz4

Build Failed

Test summary info:

Could not find result summary

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

/test connector=connectors/destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 6, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2999995344
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/2999995344
🐛 https://gradle.com/s/7ag4up7dvhwuk

Build Failed

Test summary info:

Could not find result summary

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 6, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3000216762
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3000216762
🐛 https://gradle.com/s/l7ngiar4iefiw

Build Failed

Test summary info:

Could not find result summary

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 7, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3005036580
❌ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3005036580
🐛 https://gradle.com/s/6ubsrcqpvpgpy

Build Failed

Test summary info:

Could not find result summary

… spec

added config param max_in_flight for test
@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 7, 2022

/test connector=connectors/destination-mqtt

🕑 connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3006423705
✅ connectors/destination-mqtt https://github.com/airbytehq/airbyte/actions/runs/3006423705
No Python unittests run

Build Passed

Test summary info:

All Passed

@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda
Copy link
Contributor Author

alexandr-shegeda commented Sep 7, 2022

/publish connector=connectors/destination-mqtt

🕑 Publishing the following connectors:
connectors/destination-mqtt
https://github.com/airbytehq/airbyte/actions/runs/3006788792


Connector Did it publish? Were definitions generated?
connectors/destination-mqtt

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@alexandr-shegeda alexandr-shegeda merged commit d105177 into master Sep 7, 2022
@alexandr-shegeda alexandr-shegeda deleted the osheg/16219-destination-mqtt branch September 7, 2022 10:36
@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2022

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

  • destination-mqtt

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets September 7, 2022 10:38 Inactive
robbinhan pushed a commit to robbinhan/airbyte that referenced this pull request Sep 29, 2022
…irbytehq#16263)

* [16219] MQTT Destination: Password is not marked as a secret field in spec

* [16219] MQTT Destination: Password is not marked as a secret field in spec

* [16219] MQTT Destination: Password is not marked as a secret field in spec
added logs for troubleshooting

* [16219] MQTT Destination: Password is not marked as a secret field in spec
updated maxinflight and connect_timeout for test only

* [16219] MQTT Destination: Password is not marked as a secret field in spec
updated maxinflight for test only

* [16219] MQTT Destination: Password is not marked as a secret field in spec
added config param max_in_flight for test

* [16219] MQTT Destination: Password is not marked as a secret field in spec
made refactoring

* auto-bump connector version [ci skip]

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
…irbytehq#16263)

* [16219] MQTT Destination: Password is not marked as a secret field in spec

* [16219] MQTT Destination: Password is not marked as a secret field in spec

* [16219] MQTT Destination: Password is not marked as a secret field in spec
added logs for troubleshooting

* [16219] MQTT Destination: Password is not marked as a secret field in spec
updated maxinflight and connect_timeout for test only

* [16219] MQTT Destination: Password is not marked as a secret field in spec
updated maxinflight for test only

* [16219] MQTT Destination: Password is not marked as a secret field in spec
added config param max_in_flight for test

* [16219] MQTT Destination: Password is not marked as a secret field in spec
made refactoring

* auto-bump connector version [ci skip]

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/destination/mqtt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MQTT Destination: Password is not marked as a secret field in spec
6 participants