Adding instance -> custom_headers and instance -> api_path #239

augustinosusky · 2023-02-06T14:47:19Z

SUMMARY

Adding functionality to add custom headers under instance parameter. This may be required if you are using API gateways intercepting API requests and then forwarding requests to the real endpoint.
Adding functionality to add custom api path in case it differs from the usual "api/now" path. For example if API gateway needs this.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

adding instance->custom_headers and instance->api_path parameters. This affects arguments.py, client.py, table.py and attachment.py in plugins/module_utils folder.

ADDITIONAL INFORMATION

Example call for configuration item:

- hosts: localhost
  gather_facts: no
  tasks:
    - name: Get CI
      servicenow.itsm.configuration_item_info:
        instance:
          host: https://apigateway.example.com
          username: automation_user
          password: xyz
          custom_headers: { X-APIGW-APIKEY: xyz }
          api_path: "servicenow/v1/now"

        sys_class_name: cmdb_ci_server
        sysparm_query: "fqdn=myserver.exmple.com"
      register: result

    - name: debug
      debug:
        msg: "{{ result }}"

…atible with python 2.*

…it was not picking up default value

softwarefactory-project-zuul · 2023-02-06T15:03:13Z

Build succeeded.

docs/servicenow.itsm.problem_task_info_module.rst

* fixing default api_path as it should be api/now * improving documentation, changing _path functions to be backward compatible with python 2.* * fixing deviations from pep8 standards * adding default value setting into mocker for the Client as otherwise it was not picking up default value

softwarefactory-project-zuul · 2023-07-14T21:43:05Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/207f043a5b384b33befb0a20d0c9d965

✔️ build-ansible-collection SUCCESS in 6m 44s
✔️ ansible-test-sanity-docker-devel SUCCESS in 8m 12s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 8m 43s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 9m 12s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 9m 06s
❌ ansible-test-sanity-docker-stable-2.11 FAILURE in 15m 40s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 6m 37s
❌ ansible-test-units-servicenow-itsm-python27 FAILURE in 6m 16s
❌ ansible-test-units-servicenow-itsm-python36 FAILURE in 4m 14s
❌ ansible-test-units-servicenow-itsm-python37 FAILURE in 5m 23s
❌ ansible-test-units-servicenow-itsm-python38 FAILURE in 4m 39s
✔️ ansible-galaxy-importer SUCCESS in 3m 42s

Akasurde · 2023-07-14T22:01:25Z

recheck

softwarefactory-project-zuul · 2023-07-14T22:29:26Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/dcddfcbf3ff146a1ab26deeb95e86212

✔️ build-ansible-collection SUCCESS in 6m 47s
✔️ ansible-test-sanity-docker-devel SUCCESS in 10m 08s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 9m 25s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 19m 46s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 9m 21s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 10m 36s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 11m 08s
❌ ansible-test-units-servicenow-itsm-python27 FAILURE in 4m 49s
❌ ansible-test-units-servicenow-itsm-python36 FAILURE in 4m 43s
❌ ansible-test-units-servicenow-itsm-python37 FAILURE in 4m 31s
❌ ansible-test-units-servicenow-itsm-python38 FAILURE in 5m 49s
✔️ ansible-galaxy-importer SUCCESS in 4m 09s

Akasurde · 2023-07-25T15:18:08Z

@augustinosusky Could you please update/fix these CI failures? Thanks

augustinosusky · 2023-07-25T15:57:20Z

@augustinosusky Could you please update/fix these CI failures? Thanks

Hello @Akasurde ,
I will check it and try to resolve it. I will also check and remove documentation updates since they are generated automatically.

Thank you for addressing this.

…tically generated

softwarefactory-project-zuul · 2023-07-26T06:52:15Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/9205db18a4544025ba9adcce1d5eaf5b

✔️ build-ansible-collection SUCCESS in 7m 01s
❌ ansible-test-sanity-docker-devel FAILURE in 11m 21s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 11m 05s (non-voting)
❌ ansible-test-sanity-docker-stable-2.9 FAILURE in 13m 33s
❌ ansible-test-sanity-docker-stable-2.10 FAILURE in 13m 37s
❌ ansible-test-sanity-docker-stable-2.11 FAILURE in 14m 48s
❌ ansible-test-sanity-docker-stable-2.12 FAILURE in 10m 31s
❌ ansible-test-units-servicenow-itsm-python27 FAILURE in 4m 21s
❌ ansible-test-units-servicenow-itsm-python36 FAILURE in 4m 40s
❌ ansible-test-units-servicenow-itsm-python37 FAILURE in 4m 10s
❌ ansible-test-units-servicenow-itsm-python38 FAILURE in 4m 06s
❌ ansible-galaxy-importer FAILURE in 3m 17s

softwarefactory-project-zuul · 2023-07-26T07:42:28Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/03f06664b1dc4ed1830b2c1fce61ec56

✔️ build-ansible-collection SUCCESS in 7m 41s
✔️ ansible-test-sanity-docker-devel SUCCESS in 8m 45s (non-voting)
❌ ansible-test-sanity-docker-milestone FAILURE in 13m 27s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.9 SUCCESS in 10m 23s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 7m 33s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 9m 44s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 6m 43s
❌ ansible-test-units-servicenow-itsm-python27 FAILURE in 4m 26s
❌ ansible-test-units-servicenow-itsm-python36 FAILURE in 5m 15s
❌ ansible-test-units-servicenow-itsm-python37 FAILURE in 5m 49s
❌ ansible-test-units-servicenow-itsm-python38 FAILURE in 4m 08s
✔️ ansible-galaxy-importer SUCCESS in 3m 25s

…ion in table client in the old way

softwarefactory-project-zuul · 2023-07-26T07:48:41Z

Merge Failed.

This change or one of its cross-repo dependencies was unable to be automatically merged with the current state of its repository. Please rebase the change and upload a new patchset.
Warning:
Error merging github.com/ansible-collections/servicenow.itsm for 239,6a20f08d501558e3a5aa2bdc4ab50f5f1e80f446

softwarefactory-project-zuul · 2023-07-26T08:33:50Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/5002ad2331f54663a5273432c225fb92

augustinosusky · 2023-07-28T09:37:31Z

Hello @Akasurde,
It seems that the restarted build finished well now (although the log shows that there were many retries). Thank you for your help.
Is there anything else expected from me or is all ok now from pull request perspective?
Thanks again!
Augustin

augustinosusky · 2023-08-15T13:34:49Z

Hello @Akasurde ,
is there something I am still missing? Or we can proceed?
Thank you!
Augustin

Akasurde

Minor change required.

plugins/doc_fragments/instance.py

softwarefactory-project-zuul · 2023-09-01T12:40:17Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/b99244c222444528a3a8cbd1d0024a67

✔️ build-ansible-collection SUCCESS in 6m 56s
✔️ ansible-test-sanity-docker-devel SUCCESS in 6m 35s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 6m 34s (non-voting)
❌ ansible-test-sanity-docker-stable-2.9 FAILURE in 9m 41s
❌ ansible-test-sanity-docker-stable-2.10 FAILURE in 8m 19s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 14m 58s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 6m 43s
✔️ ansible-test-units-servicenow-itsm-python27 SUCCESS in 4m 36s
✔️ ansible-test-units-servicenow-itsm-python36 SUCCESS in 4m 25s
✔️ ansible-test-units-servicenow-itsm-python37 SUCCESS in 4m 24s
✔️ ansible-test-units-servicenow-itsm-python38 SUCCESS in 4m 24s
✔️ ansible-galaxy-importer SUCCESS in 3m 20s

augustinosusky · 2023-09-01T12:43:15Z

Again framework errors:
2.9 - https://ansible.softwarefactory-project.io/zuul/build/6b37af9767f54107ab292140c73f7cb8

Collecting astroid==2.3.3 (from -c /root/ansible/test/lib/ansible_test/_data/requirements/constraints.txt (line 54))
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'ReadTimeoutError("HTTPConnectionPool(host='172.17.0.2', port=3141): Read timed out. (read timeout=15)",)': /root/pypi/+simple/astroid/

2.10 - https://ansible.softwarefactory-project.io/zuul/build/82fd369988984f889762b9ec430616c0

Collecting antsibull-changelog==0.9.0 (from -r /root/ansible/test/lib/ansible_test/_data/requirements/sanity.changelog.txt (line 2))
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'ReadTimeoutError("HTTPConnectionPool(host='172.17.0.2', port=3141): Read timed out. (read timeout=15)",)': /root/pypi/+simple/antsibull-changelog/

I will add some empty commit to start it again.

softwarefactory-project-zuul · 2023-09-01T13:08:00Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/6d1819b4ac734bbb8b5d04b3c166c822

✔️ build-ansible-collection SUCCESS in 6m 38s
✔️ ansible-test-sanity-docker-devel SUCCESS in 11m 05s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 12m 32s (non-voting)
❌ ansible-test-sanity-docker-stable-2.9 FAILURE in 9m 55s
✔️ ansible-test-sanity-docker-stable-2.10 SUCCESS in 12m 27s
✔️ ansible-test-sanity-docker-stable-2.11 SUCCESS in 10m 06s
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 10m 04s
✔️ ansible-test-units-servicenow-itsm-python27 SUCCESS in 5m 58s
✔️ ansible-test-units-servicenow-itsm-python36 SUCCESS in 5m 46s
✔️ ansible-test-units-servicenow-itsm-python37 SUCCESS in 5m 40s
✔️ ansible-test-units-servicenow-itsm-python38 SUCCESS in 5m 13s
✔️ ansible-galaxy-importer SUCCESS in 3m 59s

Akasurde · 2023-09-01T14:57:51Z

recheck

softwarefactory-project-zuul · 2023-09-01T15:19:53Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/bbe7a0b158104ef4bf3cb60a4484574f

Akasurde · 2023-09-01T15:23:45Z

@juremedvesek @uscinski Can you please take a look? Thanks in advance.

augustinosusky · 2023-09-19T13:45:30Z

Hello, @juremedvesek @uscinski ,
please, let me know in case you have additional comments or requests. I'll be happy to address them.
Best Regards,
Augustin

juremedvesek

LGTM. But would like to ask, what is additional value - to be able to use different API's inside url module, or to cover installation, that do not expose service now on root? Thanks.

juremedvesek · 2023-09-20T06:25:33Z

@Akasurde - changes looks good, they make additional extensions possible.

augustinosusky · 2023-09-20T13:23:52Z

LGTM. But would like to ask, what is additional value - to be able to use different API's inside url module, or to cover installation, that do not expose service now on root? Thanks.

Hello @juremedvesek,
the main reason for adding these is to allow usage of API gateways which serve as proxies to multiple services' API endpoints, SNOW among them. We have such an API GW and:

it uses part of the url to forward the request to SNOW API. In our case we access "https://<API_GW_HOST>/servicenow/v1/now" and it gets forwarded to "https://<SNOW_HOST>/api/now"
- this is controlled by "api_path" parameter
it needs own authentication token in headers to authenticate against API GW as well
- this is controlled indirectly by allowing "custom_headers" parameter as every API GW will probably have own name for the token

augustinosusky · 2023-10-12T12:14:48Z

Hello @juremedvesek,
please, let me know if my last comment is sufficient or you would like to address any other topics.
Cheers,
Augustin

juremedvesek · 2023-10-12T12:17:15Z

@augustinosusky can you please ping @Akasurde . From my point it is ok, but also him must confirm.

augustinosusky · 2023-10-12T12:21:45Z

Hello @Akasurde ,
please let me know if all is ok also from your side.
Thank you!
Augustin

augustinosusky · 2023-10-20T05:07:04Z

Hello @Akasurde , is there anything else needed to be addressed?
Thank you!
Augustin

Akasurde · 2023-10-23T04:07:00Z

@augustinosusky Sorry for the delay. I was afk.

softwarefactory-project-zuul · 2023-10-23T04:38:02Z

Build failed (gate pipeline). For information on how to proceed, see
http://docs.openstack.org/infra/manual/developers.html#automated-testing

https://ansible.softwarefactory-project.io/zuul/buildset/cc69dcc2d8e549f2b887907fbfad9af0

augustinosusky · 2023-10-23T05:27:34Z

@Akasurde
No problem at all, thank you for accepting the pull request.
Unfortunately, there was again some internal api call timeout in the build process and one of the checks timed out on http request read. Not sure why the automation gets so many timeouts in last months.

softwarefactory-project-zuul · 2023-10-23T06:49:27Z

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/b98707efdeec45dbb4911c0d71143b42

Akasurde · 2023-10-23T07:50:08Z

@augustinosusky Thanks for the contribution. @juremedvesek Thanks for the review.

augustinosusky · 2023-10-23T08:39:14Z

@augustinosusky , @juremedvesek thank you very much for your help!

Augustin Osusky added 6 commits February 6, 2023 10:08

adding documentation first to check how it looks in git

edfc414

now adding code, tested for querying real production (cmdb_ci table)

524eca9

fixing default api_path as it should be api/now

3ef20ef

improving documentation, changing _path functions to be backward comp…

aa70915

…atible with python 2.*

fixing deviations from pep8 standards

6214a94

adding default value setting into mocker for the Client as otherwise …

0ce162e

…it was not picking up default value

augustinosusky marked this pull request as draft April 26, 2023 05:04

augustinosusky marked this pull request as ready for review April 26, 2023 05:04

tima requested review from Akasurde and juremedvesek July 13, 2023 20:12

Akasurde requested changes Jul 14, 2023

View reviewed changes

docs/servicenow.itsm.problem_task_info_module.rst Outdated Show resolved Hide resolved

Akasurde force-pushed the main branch from 0ce162e to 635aec0 Compare July 14, 2023 21:20

Akasurde self-requested a review July 14, 2023 21:20

Akasurde mentioned this pull request Jul 14, 2023

Allow servicenow.itsm.api to call API outside /api/now/table/ namespace #247

Closed

Augustin Osusky added 2 commits July 26, 2023 08:06

pulling update from main repository and resolving conflicts

d32c415

removing manually added documentation lines in files which are automa…

34305d3

…tically generated

adding another conflict resolution

375d864

addressing commit into main repository d143c52 which used _path funct…

6a20f08

…ion in table client in the old way

merging from upstream completely and resolving conflict

d864463

Akasurde requested changes Aug 17, 2023

View reviewed changes

plugins/doc_fragments/instance.py Outdated Show resolved Hide resolved

plugins/doc_fragments/instance.py Outdated Show resolved Hide resolved

updating minor version when this will be released

343fdbb

restart automatic build

b8a1e82

juremedvesek approved these changes Sep 20, 2023

View reviewed changes

Akasurde approved these changes Oct 23, 2023

View reviewed changes

Akasurde added the mergeit label Oct 23, 2023

Akasurde added mergeit and removed mergeit labels Oct 23, 2023

softwarefactory-project-zuul bot merged commit 142e374 into ansible-collections:main Oct 23, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding instance -> custom_headers and instance -> api_path #239

Adding instance -> custom_headers and instance -> api_path #239

augustinosusky commented Feb 6, 2023

softwarefactory-project-zuul bot commented Feb 6, 2023

softwarefactory-project-zuul bot commented Jul 14, 2023

Akasurde commented Jul 14, 2023

softwarefactory-project-zuul bot commented Jul 14, 2023

Akasurde commented Jul 25, 2023

augustinosusky commented Jul 25, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

augustinosusky commented Jul 28, 2023

augustinosusky commented Aug 15, 2023

Akasurde left a comment

softwarefactory-project-zuul bot commented Sep 1, 2023

augustinosusky commented Sep 1, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented Sep 1, 2023

Akasurde commented Sep 1, 2023

softwarefactory-project-zuul bot commented Sep 1, 2023

Akasurde commented Sep 1, 2023

augustinosusky commented Sep 19, 2023

juremedvesek left a comment

juremedvesek commented Sep 20, 2023

augustinosusky commented Sep 20, 2023

augustinosusky commented Oct 12, 2023

juremedvesek commented Oct 12, 2023

augustinosusky commented Oct 12, 2023

augustinosusky commented Oct 20, 2023

Akasurde commented Oct 23, 2023

softwarefactory-project-zuul bot commented Oct 23, 2023

augustinosusky commented Oct 23, 2023

softwarefactory-project-zuul bot commented Oct 23, 2023

Akasurde commented Oct 23, 2023

augustinosusky commented Oct 23, 2023

Adding instance -> custom_headers and instance -> api_path #239

Adding instance -> custom_headers and instance -> api_path #239

Conversation

augustinosusky commented Feb 6, 2023

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

softwarefactory-project-zuul bot commented Feb 6, 2023

softwarefactory-project-zuul bot commented Jul 14, 2023

Akasurde commented Jul 14, 2023

softwarefactory-project-zuul bot commented Jul 14, 2023

Akasurde commented Jul 25, 2023

augustinosusky commented Jul 25, 2023 • edited Loading

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

softwarefactory-project-zuul bot commented Jul 26, 2023

augustinosusky commented Jul 28, 2023

augustinosusky commented Aug 15, 2023

Akasurde left a comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Sep 1, 2023

augustinosusky commented Sep 1, 2023 • edited Loading

softwarefactory-project-zuul bot commented Sep 1, 2023

Akasurde commented Sep 1, 2023

softwarefactory-project-zuul bot commented Sep 1, 2023

Akasurde commented Sep 1, 2023

augustinosusky commented Sep 19, 2023

juremedvesek left a comment

Choose a reason for hiding this comment

juremedvesek commented Sep 20, 2023

augustinosusky commented Sep 20, 2023

augustinosusky commented Oct 12, 2023

juremedvesek commented Oct 12, 2023

augustinosusky commented Oct 12, 2023

augustinosusky commented Oct 20, 2023

Akasurde commented Oct 23, 2023

softwarefactory-project-zuul bot commented Oct 23, 2023

augustinosusky commented Oct 23, 2023

softwarefactory-project-zuul bot commented Oct 23, 2023

Akasurde commented Oct 23, 2023

augustinosusky commented Oct 23, 2023

augustinosusky commented Jul 25, 2023 •

edited

Loading

augustinosusky commented Sep 1, 2023 •

edited

Loading