Skip to content

Commit d66078f

Browse files
docs(adms): document integration test env vars and fix wrong field names
- Add ADMS placeholder block to .env_integration_tests.example so reviewers know which env vars to set for external/BTP mode. - Correct the env var names in conftest docstring and INTEGRATION_TESTS_ADMS.md: the loader expects CLIENTID / CLIENTSECRET / URL / URI (matching the IAS binding field names used by destination/), not the underscored CLIENT_ID / IAS_URL / SERVICE_URL variants — those would have failed with KeyError. - Add the optional RESOURCE entry (IAS resource URI) the docs were missing. - Rename leftover "DMS Integration Tests" heading to "ADMS Integration Tests".
1 parent d18d875 commit d66078f

3 files changed

Lines changed: 22 additions & 9 deletions

File tree

.env_integration_tests.example

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,13 @@ CLOUD_SDK_CFG_SDM_DEFAULT_UAA='{"url":"https://your-auth-url","clientid":"your-c
2525

2626
CLOUD_SDK_CFG_HANA_AGENT_MEMORY_DEFAULT_APPLICATION_URL=https://your-agent-memory-api-url-here
2727
CLOUD_SDK_CFG_HANA_AGENT_MEMORY_DEFAULT_UAA='{"url":"https://your-auth-url","clientid":"your-client-id","clientsecret":"your-client-secret"}'
28+
29+
# ADMS (Advanced Document Management Service) — external/BTP integration tests.
30+
# Set CLOUD_SDK_ADMS_INTEGRATION_URL to switch the test fixtures from local
31+
# HDM auto-start to a deployed ADMS instance.
32+
CLOUD_SDK_ADMS_INTEGRATION_URL=https://your-adm-host.cfapps.eu20.hana.ondemand.com
33+
CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTID=your-adms-client-id-here
34+
CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTSECRET=your-adms-client-secret-here
35+
CLOUD_SDK_CFG_ADMS_DEFAULT_URL=https://your-tenant.accounts.ondemand.com
36+
CLOUD_SDK_CFG_ADMS_DEFAULT_URI=https://your-adm-host.cfapps.eu20.hana.ondemand.com
37+
CLOUD_SDK_CFG_ADMS_DEFAULT_RESOURCE=urn:sap:identity:application:provider:name:your-adm-app-name

docs/INTEGRATION_TESTS_ADMS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DMS Integration Tests
1+
# ADMS Integration Tests
22

33
End-to-end tests that verify the `sap_cloud_sdk.adms` module is correctly wired to a running **SAP Advanced Document Management (ADM / HDM)** server.
44

@@ -45,10 +45,11 @@ HDM startup takes ~30–60 seconds on first run. The server is kept alive for th
4545

4646
```bash
4747
export CLOUD_SDK_ADMS_INTEGRATION_URL=https://your-adm.cfapps.eu20.hana.ondemand.com
48-
export CLOUD_SDK_CFG_ADMS_DEFAULT_SERVICE_URL=$CLOUD_SDK_ADMS_INTEGRATION_URL
49-
export CLOUD_SDK_CFG_ADMS_DEFAULT_IAS_URL=https://your-tenant.accounts.ondemand.com
50-
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENT_ID=...
51-
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENT_SECRET=...
48+
export CLOUD_SDK_CFG_ADMS_DEFAULT_URL=https://your-tenant.accounts.ondemand.com
49+
export CLOUD_SDK_CFG_ADMS_DEFAULT_URI=$CLOUD_SDK_ADMS_INTEGRATION_URL
50+
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTID=...
51+
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTSECRET=...
52+
export CLOUD_SDK_CFG_ADMS_DEFAULT_RESOURCE=urn:sap:identity:application:provider:name:your-app
5253

5354
.venv/bin/python -m pytest tests/adms/integration/ -m integration -v
5455
```

tests/adms/integration/conftest.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Pytest fixtures for DMS end-to-end integration tests.
2+
Pytest fixtures for ADMS end-to-end integration tests.
33
44
Two modes are supported — controlled by environment variables:
55
@@ -10,9 +10,11 @@
1010
env-var pattern (CLOUD_SDK_CFG_ADMS_DEFAULT_*).
1111
1212
export CLOUD_SDK_ADMS_INTEGRATION_URL=https://your-adm.cfapps.eu20.hana.ondemand.com
13-
export CLOUD_SDK_CFG_ADMS_DEFAULT_IAS_URL=https://your-tenant.accounts.ondemand.com
14-
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENT_ID=...
15-
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENT_SECRET=...
13+
export CLOUD_SDK_CFG_ADMS_DEFAULT_URL=https://your-tenant.accounts.ondemand.com
14+
export CLOUD_SDK_CFG_ADMS_DEFAULT_URI=https://your-adm.cfapps.eu20.hana.ondemand.com
15+
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTID=...
16+
export CLOUD_SDK_CFG_ADMS_DEFAULT_CLIENTSECRET=...
17+
export CLOUD_SDK_CFG_ADMS_DEFAULT_RESOURCE=urn:sap:identity:application:provider:name:your-app
1618
1719
MODE 2 — Local HDM server (auto-started)
1820
-----------------------------------------

0 commit comments

Comments
 (0)