sn-donbenjamin / cern-snow-client Goto Github PK

Welcome to the cern-snow-client library, which facilitates the usage of the ServiceNow REST API with a CERN Single Sign On account, such as a CERN service account. Basic Authentication is also supported.

The library is compatible with Python 2.6 and Python 2.7 but not Python 3 yet.

The library code is in the package cern_snow_client, and example usage is in examples/main.py. You should modify the configuration file examples/config.yaml as well.

To have access to the ServiceNow APIs, please read first KB0003644: Access to SNow APIs with a Service Account and KB0003521: Retrieving information from ServiceNow using REST and SOAP.

To request access for your service account, please fill in the form Request access to SNow API for a Service Account.

If for some reason you cannot use a CERN Service Account, please read KB0003645: Access to SNow APIs with a ServiceNow Local Account.

The motivation for the development of this library is:

• Providing a common, reliable and documented Python client library for ServiceNow users, both in the IT Department and other CERN departments
• Reducing implementation and support costs of integrations with ServiceNow at CERN

• First, you need a config file. You can use the included example examples/config.yaml. The plan later on is to have a config file generation tool.
• You can try the library interactively. Example below:

python
...
>>> from cern_snow_client.session import SnowRestSession
>>> s = SnowRestSession()
>>> s.load_config_file('config.yaml')  # points to cerntraining.service-now.com
>>> inc = Incident(s)
>>> if inc.get('c1c535ba85f45540adf94de5b835cd43'):
>>>     print inc.short_description
>>> inc2 = Incident(s)
>>> if inc2.get(('number', 'INC0426232')):
>>>     print inc2.short_description

• You can see more the documentation for the class SnowRestSession in the snow-client documentation website and more examples in the file examples/main.py.

Important : with the included example config.yaml, a cookie file cookie.txt and a token file tokens.txt will be generated as a cache to avoid reauthenticating between requests. These files have to be stored securely, as anyone with access to them could impersonate your account in ServiceNow or even another SSO-enabled CERN system. If you are just testing, be sure to delete the files after running main.py.

You can clone this git repository, using the URL at the top of this page, for example with:

git clone https://:@gitlab.cern.ch:8443/servicenow/snow-client.git

You can then copy the package (folder) cern_snow_client into your Python project.

You can also download a .zip or .tar.gz file from this project.

At the moment, there is no CLI around the library, other than using it interactively from the Python interpreter.

Developing a CLI is in the issue list. If you would like to contribute, please get in touch with us so as to coordinate the effort.

The current documentation is in the snow-client documentation website.

First, create a tests/config_files/passwords.yaml file. The following content needs to be added:

basic_good : <password of the account snow_client_basic_tests>
oauth_client_secret_good: <secret of the OAuth Client App 1b606d966a008380d686014a4cc61e42>

You can request the values of these passwords to the ServiceNow developers team ([email protected]) if you need to carry unit tests.

Tests should never be done in the ServiceNow production instance cern.service-now.com . The target instance is controlled by the instance parameter in the .yaml configuration file.

While in the root of the project, please run tests/run_python26.sh or tests/run_python27.sh.

The SSO+OAuth tests will only work in an environment with the tool cern-get-sso-cookie (e.g. Scientific Linux CERN or CERN CentOS).

Tested environments are lxplus.cern.ch (currently Python 2.6) and aiadm (currently Python 2.7).

Please check our Issue List to see the planned improvements.

Any ideas or contributions are welcome. Please get in touch with us.

James Clerc [email protected] [email protected]

David Martin Clavo [email protected]