Oauth2 feature added

[fepatrifork]

Description

These changes add the capability to manage the Oauth2 authentication/authorization using JWT token provided by an IdP. The modification involves different levels of the system that is possible to refer as frontend for the part of the powerBI connector that is defined in Power Query (M) and backend for the part that contains the ODBC driver logic. The modification on the frontend (PowerBI connector) comprehends the management of the Authorization Code Flow "OAUTH2" using the predefined callbacks StartLogin, FinishLogin, Refresh, Logout and the configuration of the flow comes from a JSON file (template provided). This level passes the token to the backend (ODBC driver) that manages the information received to make an HTTP request with a different header. The modification includes the" ODBC Data Sources Administrator" that now allows the selection of the "OAUTH2" option for inserting a token in a created field and testing the connection. The modification of the token information has a similar treatment of the password in "BASIC" during the whole logic, with adapting due to the string size of the token. After installing the re-packaged .msi file, a system test was settled and passed using "PowerBI Desktop" and in " ODBC Data Sources Administrator" with a localhost database. The result of unit-test integration-test are made with the provided script test_runner.py modified to exclude .recipe extension that does not allow running all the tests. Test cases, documentation, user manual and DCO can be provided and expanded if there is an interest in this work and you consider it valuable.

Issues Resolved

Added Oauth2 feature

Check List

• [x] New functionality includes testing.
  • [ ] All tests pass, including unit test, integration test and doctest
  • [X] Not all tests pass, including unit test, integration test and doctest
• [X] New functionality has been documented.
  • [ ] New functionality has javadoc added
  • [X] New functionality has user manual doc added
• [X] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[rupal-bq]

Can you please take a look at failed CI?

[fepatrifork]

Can you please take a look at failed CI?

I take care of the followings:

• [x] I have to add the DCO for all commits
• [x] Some weblinks are missing endpoint in old .md files (not modified from this pull request)
  • SOLUTION: modify the missing endpoint with the redirected link or refer a MD file from this repo
• [x] Linux environment seems having problem in CPPCheck
  • ERROR MESSAGE: "src/opensearchenlist/msdtc_enlist.cpp:1114:49: error: There is an unknown macro here somewhere. Configuration is required. If KEYWORD_DTC_CHECK is a macro then please configure it. [unknownMacro] strcat(dtcname, ";" KEYWORD_DTC_CHECK "=0");".
    • SOLUTION: pushed a solution for msdtc_enlist.cpp.

Looking forward for feedback after re-CI!

[rupal-bq]

@fepatrifork Thanks for looking into CI failures. Can you please also add test cases, documentation and user manual?

[fepatrifork]

@fepatrifork Thanks for looking into CI failures. Can you please also add test cases, documentation and user manual?

You're welcome. I see some other error:

1. Link Checker now should finally ok with the last push
2. Can you provide help with the error of cppcheck? Before was a clear error, now it seems all ok, but do not pass the test.

For the next steps:

1. [x] For documentation and user manual I can integrate and enrich the pre-existent .md file for PowerBI connector and for the driver. Is that ok?
2. [x] For the test cases will take some time.
   • SOLUTION: Added tests in test_conn.cpp in UnitTests and an IntegrationTest in ITODBCOauth folder. Integration test use a function that make a request to the IdP with client-credentials flow to get the token. Of course is fitted for our system, if you have an active webAPI with an IdP that can be reached with a test user, it will be perfect.

[rupal-bq]

Can you provide help with the error of cppcheck? Before was a clear error, now it seems all ok, but do not pass the test:

Sure, I'll take a look

For documentation and user manual I can integrate and enrich the pre-existent .md file for PowerBI connector and for the driver. Is that ok?

Yes

[fepatrifork]

• Some tests did not pass, because of some number of values returned are different, for example in test_query_execution.cpp the test:

  all_columns_flights_count = 25 is not equal to result -> num_fields = 27

• I take a look over the Cppcheck error running, it seems that the only error resides inside in the vcpkg src\vcpkg_installed\..... that belongs to external packages manager I suppose. The others are only information-messages, that I hope they are not considered.