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

🎉 Source File: separate secure fork #6768

Merged
merged 27 commits into from Oct 20, 2021
Merged

Conversation

antixar
Copy link
Contributor

@antixar antixar commented Oct 5, 2021

What

Local storages can be used for local single environment and can't be available for clould platforms.

How

This new connector reuses all business logic of the native connector "Source File" and removes support of local storages only.

Pre-merge Checklist

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

@CLAassistant
Copy link

CLAassistant commented Oct 5, 2021

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ antixar
❌ Maksym Pavlenok


Maksym Pavlenok seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@antixar antixar self-assigned this Oct 5, 2021
@antixar antixar linked an issue Oct 5, 2021 that may be closed by this pull request
4 tasks
@antixar antixar temporarily deployed to more-secrets October 5, 2021 15:32 Inactive
@github-actions github-actions bot added the area/connectors Connector related issues label Oct 5, 2021
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Oct 6, 2021
@antixar
Copy link
Contributor Author

antixar commented Oct 6, 2021

/test connector=connectors/source-file-secure

🕑 connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313187358
❌ connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313187358
🐛 https://gradle.com/s/tzyplu6kthzn2

@antixar antixar temporarily deployed to more-secrets October 6, 2021 18:35 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 18:38 Inactive
@antixar
Copy link
Contributor Author

antixar commented Oct 6, 2021

/test connector=connectors/source-file-secure

🕑 connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313219312
❌ connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313219312
🐛 https://gradle.com/s/majow4njilodw

@antixar antixar temporarily deployed to more-secrets October 6, 2021 18:47 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 18:48 Inactive
@antixar
Copy link
Contributor Author

antixar commented Oct 6, 2021

/test connector=connectors/source-file-secure

🕑 connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313404077
✅ connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1313404077
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                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 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     24    41%
	 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     111     11    90%
	 ------------------------------------------------------------------------
	 TOTAL                                                  856    416    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                       Stmts   Miss  Cover
	 --------------------------------------------------------------
	 base_python/__init__.py                       13      0   100%
	 base_python/catalog_helpers.py                10      6    40%
	 base_python/cdk/__init__.py                    0      0   100%
	 base_python/cdk/abstract_source.py            83     59    29%
	 base_python/cdk/streams/__init__.py            0      0   100%
	 base_python/cdk/streams/auth/__init__.py       0      0   100%
	 base_python/cdk/streams/auth/core.py           8      1    88%
	 base_python/cdk/streams/auth/jwt.py            5      5     0%
	 base_python/cdk/streams/auth/oauth.py         37     26    30%
	 base_python/cdk/streams/auth/token.py          9      4    56%
	 base_python/cdk/streams/core.py               63     32    49%
	 base_python/cdk/streams/exceptions.py         10      2    80%
	 base_python/cdk/streams/http.py               67     33    51%
	 base_python/cdk/streams/rate_limiting.py      30     14    53%
	 base_python/cdk/utils/__init__.py              0      0   100%
	 base_python/cdk/utils/casing.py                4      0   100%
	 base_python/client.py                         56     33    41%
	 base_python/entrypoint.py                     70     56    20%
	 base_python/integration.py                    52     25    52%
	 base_python/logger.py                         33     19    42%
	 base_python/schema_helpers.py                 56     41    27%
	 base_python/source.py                         51     34    33%
	 main_dev.py                                    3      3     0%
	 --------------------------------------------------------------
	 TOTAL                                        660    393    40%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                             Stmts   Miss  Cover
	 ----------------------------------------------------
	 main_dev.py                          5      5     0%
	 source_file_secure/__init__.py       2      0   100%
	 source_file_secure/source.py        42      2    95%
	 ----------------------------------------------------
	 TOTAL                               49      7    86%

@antixar antixar temporarily deployed to more-secrets October 6, 2021 19:44 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 19:45 Inactive
…zendesk_support/streams.py

Co-authored-by: George Claireaux <george@claireaux.co.uk>
@sherifnada
Copy link
Contributor

sherifnada commented Oct 20, 2021

I agree with your reasoning about why this is the correct path forward for the time being, all other "good" alternatives are very heavyweight. Let's go with this for now then.

I think I'm hesitant to introduce an environment variable to solve the platform issue because it couples the connectors more closely with the platform (it is somewhat of a hidden interface too). Let's go with this pattern for now, I think there won't be many connectors that require this hopefully

@antixar antixar temporarily deployed to more-secrets October 20, 2021 07:54 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:02 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:08 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:11 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:14 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:26 Inactive
@antixar antixar temporarily deployed to more-secrets October 20, 2021 08:30 Inactive
@antixar
Copy link
Contributor Author

antixar commented Oct 20, 2021

/test connector=connectors/source-file-secure

🕑 connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1362695477
❌ connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1362695477
🐛 https://gradle.com/s/fuew7sfcc76a4

@jrhizor jrhizor temporarily deployed to more-secrets October 20, 2021 08:34 Inactive
@antixar
Copy link
Contributor Author

antixar commented Oct 20, 2021

/test connector=connectors/source-file-secure

🕑 connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1362847075
✅ connectors/source-file-secure https://github.com/airbytehq/airbyte/actions/runs/1362847075
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                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 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     24    41%
	 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     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  860    419    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                       Stmts   Miss  Cover
	 --------------------------------------------------------------
	 base_python/__init__.py                       13      0   100%
	 base_python/catalog_helpers.py                10      6    40%
	 base_python/cdk/__init__.py                    0      0   100%
	 base_python/cdk/abstract_source.py            83     59    29%
	 base_python/cdk/streams/__init__.py            0      0   100%
	 base_python/cdk/streams/auth/__init__.py       0      0   100%
	 base_python/cdk/streams/auth/core.py           8      1    88%
	 base_python/cdk/streams/auth/jwt.py            5      5     0%
	 base_python/cdk/streams/auth/oauth.py         37     26    30%
	 base_python/cdk/streams/auth/token.py          9      4    56%
	 base_python/cdk/streams/core.py               63     32    49%
	 base_python/cdk/streams/exceptions.py         10      2    80%
	 base_python/cdk/streams/http.py               67     33    51%
	 base_python/cdk/streams/rate_limiting.py      30     14    53%
	 base_python/cdk/utils/__init__.py              0      0   100%
	 base_python/cdk/utils/casing.py                4      0   100%
	 base_python/client.py                         56     33    41%
	 base_python/entrypoint.py                     70     56    20%
	 base_python/integration.py                    52     25    52%
	 base_python/logger.py                         33     19    42%
	 base_python/schema_helpers.py                 56     41    27%
	 base_python/source.py                         51     34    33%
	 main_dev.py                                    3      3     0%
	 --------------------------------------------------------------
	 TOTAL                                        660    393    40%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                             Stmts   Miss  Cover
	 ----------------------------------------------------
	 main_dev.py                          5      5     0%
	 source_file_secure/__init__.py       2      0   100%
	 source_file_secure/source.py        45      2    96%
	 ----------------------------------------------------
	 TOTAL                               52      7    87%

@jrhizor jrhizor temporarily deployed to more-secrets October 20, 2021 09:16 Inactive
@antixar
Copy link
Contributor Author

antixar commented Oct 20, 2021

This PR should be merged without a publish comment because this connector will be used by cloud only and will be published separately.

@antixar antixar merged commit 059645f into master Oct 20, 2021
@antixar antixar deleted the antixar/6538-source-file-secure branch October 20, 2021 09:28
@marcosmarxm
Copy link
Member

@antixar this is PR is breaking the /publish command.

##[endgroup***
##[debug***/usr/bin/bash -e /actions-runner/_work/_temp/96a960e6-9513-475f-bf5b-0c71f547bbc8.sh
Creds not set for source-file-secure
##[error***Process completed with exit code 1.
##[debug***Finishing: Write Integration Test Credentials

See: https://github.com/airbytehq/airbyte/runs/3954100006?check_suite_focus=true
From: #7218

schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
* create a fork for the source-file connector

* update docs and tests

* update docs and tests

* add secrets

Co-authored-by: George Claireaux <george@claireaux.co.uk>

* switching among auth methods

* refactoring after reviews

* correction of doc

* update spec file



Co-authored-by: Maksym Pavlenok <maksym.pavlenok@globallogic.com>
Co-authored-by: George Claireaux <george@claireaux.co.uk>
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/source/file connectors/sources-files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

forking the File connector to disallow pulling files from the local filesystem
8 participants