feat: config option to allow basic auth

[reinhard-brandstaedter]

feat: add option for basic auth when using influxdb 1.8 compatibility API

Closes #262

Proposed Changes

Add an additional option auth_basic: True|False for the InfluxDBClient, which allows to use the client in cases where reverse proxies are being used for authentication instead of InfluxDBs own authentication (applies only for InfluxDB 1.8 forward compatibility API).
Using reverse proxies is quite a common setup, so this makes it easier to integrate in such scenarios.

Checklist

• CHANGELOG.md updated
• Rebased/mergeable
• A test has been added if appropriate
• pytest tests completes successfully
• Commit messages are in semantic format
• Sign CLA (if not already signed)

[codecov-commenter]

Codecov Report

Merging #263 (cd3278c) into master (a421a6f) will decrease coverage by 0.01%.
The diff coverage is 90.00%.

@@            Coverage Diff             @@
##           master     #263      +/-   ##
==========================================
- Coverage   91.93%   91.91%   -0.02%     
==========================================
  Files          25       25              
  Lines        2033     2042       +9     
==========================================
+ Hits         1869     1877       +8     
- Misses        164      165       +1     

Impacted Files	Coverage Δ
influxdb_client/client/influxdb_client.py	98.65% <88.88%> (-0.64%)	⬇️
influxdb_client/configuration.py	84.61% <100.00%> (+0.17%)	⬆️

---

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 a421a6f...cd3278c. Read the comment docs.

[bednar]

Thanks for your PR 👍

There is a few requirements that should be satisfy before we accept the PR:

1. Please add documentation of auth_basic option to:

   influxdb-client-python/influxdb_client/client/influxdb_client.py

   Line 39 in 8c23958

   :key str ssl_ca_cert: Set this to customize the certificate file to verify the peer.

2. Add support for configuration by config_file:
   

   influxdb-client-python/influxdb_client/client/influxdb_client.py

   Line 95 in 8c23958

   def from_config_file(cls, config_file: str = "config.ini", debug=None, enable_gzip=False):

3. Add support for configuration by env_properties:
   

   influxdb-client-python/influxdb_client/client/influxdb_client.py

   Line 183 in 8c23958

   def from_env_properties(cls, debug=None, enable_gzip=False):

4. Add new configuration option to README.rst:
   
5. Add tests:

   • influxdb-client-python/tests/test_InfluxDBClient.py

     Line 55 in 4792fd5

     def test_init_from_ini_file(self):

   • influxdb-client-python/tests/test_InfluxDBClient.py

     Line 60 in 4792fd5

     def test_init_from_toml_file(self):

Regards

[reinhard-brandstaedter]

Thanks @bednar will do!

I was just wondering, since this option would only apply when using the client in combination with the 1.8 compatibility API (AFAIK disabling auth for InfluxDB 2.0 is not an option?) if this configuration option should go into the [influx2] config section or if it makes sense to introduce a [influx1] compatibility section to make it more clear that this can/should only be used in combination with 1.8.
At the time of creating the influxdb_client one can only tell that the end-user is intending to connect to a InfluxDB 1.8 by looking at the org parameter and check if its value is "-". (would that be a correct assumption?).
So maybe I should also add a safety there to avoid that someone sets the auth_basic when intending to use it against InfluxDB 2.0.

kr

[bednar]

I was just wondering, since this option would only apply when using the client in combination with the 1.8 compatibility API (AFAIK disabling auth for InfluxDB 2.0 is not an option?) if this configuration option should go into the [influx2] config section or if it makes sense to introduce a [influx1] compatibility section to make it more clear that this can/should only be used in combination with 1.8.

Good point 👍 I think we can use influx2 section with note that the option is suitable only for InfluxDB 1.8+.

At the time of creating the influxdb_client one can only tell that the end-user is intending to connect to a InfluxDB 1.8 by looking at the org parameter and check if its value is "-". (would that be a correct assumption?).

I don't think so. It is too tricky.

So maybe I should also add a safety there to avoid that someone sets the auth_basic when intending to use it against InfluxDB 2.0.

I think that a note in documentation that the option is suitable only for InfluxDB 1.8+ will be pretty enough.

[reinhard-brandstaedter]

I was just wondering, since this option would only apply when using the client in combination with the 1.8 compatibility API (AFAIK disabling auth for InfluxDB 2.0 is not an option?) if this configuration option should go into the [influx2] config section or if it makes sense to introduce a [influx1] compatibility section to make it more clear that this can/should only be used in combination with 1.8.

Good point 👍 I think we can use influx2 section with note that the option is suitable only for InfluxDB 1.8+.

Done

At the time of creating the influxdb_client one can only tell that the end-user is intending to connect to a InfluxDB 1.8 by looking at the org parameter and check if its value is "-". (would that be a correct assumption?).

I don't think so. It is too tricky.

I see, took a look and seems one can also use "-" as an org name in InfluxDB2. Indeed tricky. I'll leave it up to the user to read documentation and not use the option with 2.x

So maybe I should also add a safety there to avoid that someone sets the auth_basic when intending to use it against InfluxDB 2.0.

I think that a note in documentation that the option is suitable only for InfluxDB 1.8+ will be pretty enough.

Done

[bednar]

@reinhard-brandstaedter, thanks again for your PR 👍

Please update CHANGELOG.md and we will be ready to merge PR into master.

[bednar]

LGTM 🥇