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.

Sign up for GitHub

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

Jump to bottom

Source Google Search Console: correct spec.json file #6222

Merged
merged 5 commits into from Sep 23, 2021
Merged

Source Google Search Console: correct spec.json file #6222

merged 5 commits into from Sep 23, 2021

Conversation

marcosmarxm
Copy link
Member

@marcosmarxm marcosmarxm commented Sep 17, 2021 •
edited

What

Closes #6221

How

Correct spec.json file to work in UI.
Check video: https://www.loom.com/share/8c3fca36c2564ea1827481ea16e657a9

Recommended reading order

  1. x.java
  2. y.python

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command 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
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub 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.

@github-actions github-actions bot added the area/connectors Connector related issues label Sep 17, 2021
@marcosmarxm marcosmarxm temporarily deployed to more-secrets September 17, 2021 16:49 Inactive
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 17, 2021
@marcosmarxm
Copy link
Member Author

marcosmarxm commented Sep 17, 2021 •
edited by github-actions bot

/test connector=connectors/source-google-search-console

🕑 connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1246293759
❌ connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1246293759
🐛 https://gradle.com/s/3z7czqg5adgta

@marcosmarxm marcosmarxm temporarily deployed to more-secrets September 17, 2021 16:54 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 17, 2021 16:56 Inactive
sherifnada
sherifnada reviewed Sep 17, 2021
View reviewed changes
...-integrations/connectors/source-google-search-console/source_google_search_console/spec.json
@@ -38,7 +39,10 @@
"properties": {
"auth_type": {
"type": "string",
"const": "Client"
"const": "Client",
"enum": ["Client"],
Copy link
Contributor

Choose a reason for hiding this comment

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

is this a UI bug? pretty sure artem made it so that this format is no longer needed in the UI

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, it's a UI bug. There is a video in the issue showing the problem :(

Copy link
Contributor

Choose a reason for hiding this comment

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

can you create a follow up issue for artem if there isn't one?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi. I believe there should be some info about this in the docs, somewhere at https://docs.airbyte.io/connector-development/connector-specification-reference maybe? Could you update it?

@danieldiamond
Copy link
Contributor

danieldiamond commented Sep 22, 2021 •
edited

@marcosmarxm all good to publish new version?

@marcosmarxm marcosmarxm mentioned this pull request Sep 22, 2021
Closed
@marcosmarxm marcosmarxm temporarily deployed to more-secrets September 22, 2021 22:29 Inactive
@marcosmarxm
Copy link
Member Author

marcosmarxm commented Sep 23, 2021 •
edited by github-actions bot

/publish connector=connectors/source-google-search-console run-tests=false

🕑 connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1263955458
❌ connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1263955458

@jrhizor jrhizor temporarily deployed to more-secrets September 23, 2021 00:12 Inactive
@marcosmarxm
Copy link
Member Author

marcosmarxm commented Sep 23, 2021 •
edited by github-actions bot

/test connector=connectors/source-google-search-console

🕑 connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1264428174
✅ connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1264428174
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        74      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        45     45     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              158    109    31%
	 source_acceptance_test/tests/test_full_refresh.py       18     11    39%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     25    39%
	 source_acceptance_test/utils/compare.py                 47     20    57%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py      75     11    85%
	 ------------------------------------------------------------------------
	 TOTAL                                                  776    430    45%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                            Stmts   Miss  Cover
	 -----------------------------------------------------------------------------------
	 source_google_search_console/__init__.py                            2      0   100%
	 source_google_search_console/service_account_authenticator.py      14      7    50%
	 source_google_search_console/source.py                             32     21    34%
	 source_google_search_console/streams.py                           123     35    72%
	 -----------------------------------------------------------------------------------
	 TOTAL                                                             171     63    63%

@marcosmarxm marcosmarxm temporarily deployed to more-secrets September 23, 2021 04:03 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 23, 2021 04:04 Inactive
@marcosmarxm
Copy link
Member Author

marcosmarxm commented Sep 23, 2021 •
edited by github-actions bot

/publish connector=connectors/source-google-search-console

🕑 connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1264453990
✅ connectors/source-google-search-console https://github.com/airbytehq/airbyte/actions/runs/1264453990

@jrhizor jrhizor temporarily deployed to more-secrets September 23, 2021 04:17 Inactive
@marcosmarxm marcosmarxm temporarily deployed to more-secrets September 23, 2021 04:56 Inactive
@marcosmarxm marcosmarxm merged commit b4cca60 into master Sep 23, 2021
@marcosmarxm marcosmarxm deleted the marcos/gsc-spec-json branch September 23, 2021 05:06
@jrhizor jrhizor mentioned this pull request Sep 25, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaart gaart gaart approved these changes

@sherifnada sherifnada sherifnada approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Source Google Search Console: not able to create connector
5 participants
@marcosmarxm @danieldiamond @gaart @sherifnada @jrhizor