Skip to content

Source Freshdesk publish new version to Docker hub #13158

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

Closed
wants to merge 7 commits into from

Conversation

brianjlai
Copy link
Contributor

@brianjlai brianjlai commented May 25, 2022

What

The current version of Freshdesk in Dockerhub is stale based on a few recent changes, specifically to the spec.json file. The current code is correct, but the published image is out of date.

After fixing some permissioning stuff I also found some failing tests so fixed those too.

How

I just need an empty commit to run the /test and /publish commands for Freshdesk. Once that's done I will update the Dockerfile version and changelog and merge those changes in.

Recommended reading order

n/a

🚨 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/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

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.

@brianjlai
Copy link
Contributor Author

brianjlai commented May 25, 2022

/test connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2381546882
❌ connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2381546882
🐛 https://gradle.com/s/w6xc3ikiyg2y2

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestBasicRead::test_read[inputs0] - docker.errors.Contai...
FAILED test_full_refresh.py::TestFullRefresh::test_sequential_reads[inputs0]
FAILED test_incremental.py::TestIncremental::test_two_sequential_reads[inputs0]
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
FAILED test_incremental.py::TestIncremental::test_state_with_abnormally_large_values[inputs0]
=================== 5 failed, 19 passed in 475.55s (0:07:55) ===================

@brianjlai
Copy link
Contributor Author

brianjlai commented May 25, 2022

/test connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2387318586
❌ connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2387318586
🐛 https://gradle.com/s/k2laid65gye74

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestBasicRead::test_read[inputs0] - docker.errors.Contai...
FAILED test_full_refresh.py::TestFullRefresh::test_sequential_reads[inputs0]
FAILED test_incremental.py::TestIncremental::test_two_sequential_reads[inputs0]
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
FAILED test_incremental.py::TestIncremental::test_state_with_abnormally_large_values[inputs0]
=================== 5 failed, 19 passed in 362.48s (0:06:02) ===================

@brianjlai
Copy link
Contributor Author

note: i decided to upgrade our freshdesk test account plan to Pro so hopefully the permission errors from https://newaccount1603334233301.freshdesk.com/api/v2/skills will eventually pass. Once they do I'll publish a new version and hopefully get this connector back into the green

@brianjlai
Copy link
Contributor Author

brianjlai commented May 26, 2022

/test connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2392558917
❌ connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2392558917
🐛 https://gradle.com/s/tyfj2hzqru2ce

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestBasicRead::test_read[inputs0] - Failed: Please check...
================== 1 failed, 23 passed in 1079.56s (0:17:59) ===================

@brianjlai
Copy link
Contributor Author

brianjlai commented May 26, 2022

/test connector=bases/source-acceptance-test

🕑 bases/source-acceptance-test https://github.com/airbytehq/airbyte/actions/runs/2392565080
✅ bases/source-acceptance-test https://github.com/airbytehq/airbyte/actions/runs/2392565080
No Python unittests run

Build Passed

Test summary info:

All Passed

@brianjlai
Copy link
Contributor Author

brianjlai commented May 26, 2022

/test connector=source-acceptance-test

🕑 source-acceptance-test https://github.com/airbytehq/airbyte/actions/runs/2392602657
❌ source-acceptance-test https://github.com/airbytehq/airbyte/actions/runs/2392602657
🐛 https://gradle.com/s/rclnbqfpdp6l6

Build Failed

Test summary info:

Could not find result summary

@github-actions github-actions bot added the area/connectors Connector related issues label May 26, 2022
@brianjlai brianjlai requested a review from pedroslopez May 26, 2022 23:29
@brianjlai brianjlai marked this pull request as ready for review May 26, 2022 23:30
@brianjlai
Copy link
Contributor Author

brianjlai commented May 26, 2022

/test connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2393685763
✅ connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2393685763
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              294    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  960    246    74%
Name                           Stmts   Miss  Cover
--------------------------------------------------
source_freshdesk/source.py         4      0   100%
source_freshdesk/errors.py         8      0   100%
source_freshdesk/__init__.py       2      0   100%
source_freshdesk/client.py        38     10    74%
source_freshdesk/api.py          190     86    55%
source_freshdesk/utils.py         42     23    45%
--------------------------------------------------
TOTAL                            284    119    58%
Name                           Stmts   Miss  Cover
--------------------------------------------------
source_freshdesk/source.py         4      0   100%
source_freshdesk/errors.py         8      0   100%
source_freshdesk/__init__.py       2      0   100%
source_freshdesk/utils.py         42      2    95%
source_freshdesk/api.py          190     75    61%
source_freshdesk/client.py        38     18    53%
--------------------------------------------------
TOTAL                            284     95    67%

Build Passed

Test summary info:

All Passed

Copy link
Contributor

@pedroslopez pedroslopez left a comment

Choose a reason for hiding this comment

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

Love the green 🟢

@@ -30,7 +30,7 @@
"type": "string"
},
"auto_ticket_assign": {
"type": ["string", "null"]
"type": ["integer", "null"]
Copy link
Contributor

Choose a reason for hiding this comment

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

just curious, how did you find these schema issues?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So the test_core.test_read() test has a validate schema check which was failing during the SAT run above. So then just to double check I made the requests against the freshdesk API in postman and updated all the types accordingly.

@codecov
Copy link

codecov bot commented May 27, 2022

Codecov Report

❗ No coverage uploaded for pull request base (master@da88158). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #13158   +/-   ##
=========================================
  Coverage          ?   66.54%           
=========================================
  Files             ?        6           
  Lines             ?      284           
  Branches          ?        0           
=========================================
  Hits              ?      189           
  Misses            ?       95           
  Partials          ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da88158...140685b. Read the comment docs.

@brianjlai
Copy link
Contributor Author

brianjlai commented May 27, 2022

/test connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2398196934
✅ connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2398196934
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              294    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  960    246    74%
Name                           Stmts   Miss  Cover
--------------------------------------------------
source_freshdesk/source.py         4      0   100%
source_freshdesk/errors.py         8      0   100%
source_freshdesk/__init__.py       2      0   100%
source_freshdesk/client.py        38     10    74%
source_freshdesk/api.py          190     86    55%
source_freshdesk/utils.py         42     23    45%
--------------------------------------------------
TOTAL                            284    119    58%
Name                           Stmts   Miss  Cover
--------------------------------------------------
source_freshdesk/source.py         4      0   100%
source_freshdesk/errors.py         8      0   100%
source_freshdesk/__init__.py       2      0   100%
source_freshdesk/utils.py         42      2    95%
source_freshdesk/api.py          190     75    61%
source_freshdesk/client.py        38     18    53%
--------------------------------------------------
TOTAL                            284     95    67%

Build Passed

Test summary info:

All Passed

@brianjlai
Copy link
Contributor Author

brianjlai commented May 27, 2022

/publish connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2398483904
❌ Failed to publish connectors/source-freshdesk
❌ Couldn't auto-bump version for connectors/source-freshdesk

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label May 27, 2022
@brianjlai
Copy link
Contributor Author

brianjlai commented May 27, 2022

/publish connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2399212035
❌ Failed to publish connectors/source-freshdesk
❌ Couldn't auto-bump version for connectors/source-freshdesk

@brianjlai
Copy link
Contributor Author

brianjlai commented May 28, 2022

/publish connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2399397459
❌ Failed to publish connectors/source-freshdesk
❌ Couldn't auto-bump version for connectors/source-freshdesk

@alafanechere
Copy link
Contributor

alafanechere commented May 30, 2022

/publish connector=connectors/source-freshdesk

🕑 connectors/source-freshdesk https://github.com/airbytehq/airbyte/actions/runs/2407816612
❌ Failed to publish connectors/source-freshdesk
❌ Couldn't auto-bump version for connectors/source-freshdesk

@alafanechere
Copy link
Contributor

alafanechere commented May 30, 2022

I'm trying to publish because I want #12334 to depend on it.

@brianjlai
Copy link
Contributor Author

@alafanechere sounds good to me! the code should be ready to publish but i was running into a few issues Friday afternoon w/ the publish script. If it publishes successfully on your run, feel free to merge this in to unblock the other contributor

@alafanechere
Copy link
Contributor

alafanechere commented May 30, 2022

@brianjlai I might rather close this PR as I got a successful test run on #12334 thanks to your Freshdesk upgrade.

@alafanechere
Copy link
Contributor

I successfully published a new version for this connector with #12334

@brianjlai brianjlai deleted the brian/publish_freshdesk branch August 16, 2023 19:04
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants