docs(deploy-tooling): port README credentials docs and CLI test from PR #3384

- Add Credentials section to README explaining env: variable requirement
- Update --username/--password CLI option descriptions in deploy and undeploy tables
- Add cliCmdWithBasicAuth test case to CLI integration tests

Author: longieirl

packages/deploy-tooling/README.md

@@ -72,6 +72,31 @@ This is the minimal custom task configuration for deployment using package `$TMP
       - /test/
 ```
 
+#### Credentials
+
+You can provide credentials for the ABAP system using environment variables. The credentials are required for authentication against the ABAP system. Plain text credentials are not supported, use environment variables instead.
+
+```yaml
+- name: abap-deploy-task
+  configuration:
+    credentials:
+      username: env:XYZ_USER
+      password: env:XYZ_PASSWORD
+    app:
+      name: Z_TEST
+      package: $TMP
+    target:
+      url: https://target.example
+    exclude:
+      - /test/
+```
+Create an `.env` file in the root of your project with the following content:
+
+```
+XYZ_USER=your-username
+XYZ_PASSWORD=your-password
+```
+
 #### Configuration with logging enabled
 Set the level of detail for log messages, default is `Info`;
 ```json
@@ -129,8 +154,8 @@ Options:
   --cloud                              target is an ABAP Cloud system
   --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
   --cloud-service-env                  Load ABAP cloud service properties from either a .env file or your environment variables. Secrets in your .env should not be committed to source control.
-  --username                           ABAP Service username
-  --password                           ABAP Service password
+  --username                           ABAP Service username, plain text credentials are not supported, use environment variables
+  --password                           ABAP Service password, plain text credentials are not supported, use environment variables
   --authentication-type                Authentication type for the app (e.g. 'basic', 'reentranceTicket'). Required for 'reentranceTicket'.
   --create-transport                   Create a transport request during deployment/undeployment
   --transport <transport-request>      Transport number to record the change in the ABAP system
@@ -206,8 +231,8 @@ Options:
   --cloud                              target is an ABAP Cloud system
   --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
   --cloud-service-env                  Load ABAP cloud service properties from either a .env file or your environment variables
-  --username                           ABAP Service username
-  --password                           ABAP Service password
+  --username                           ABAP Service username, plain text credentials are not supported, use environment variables
+  --password                           ABAP Service password, plain text credentials are not supported, use environment variables
   --authentication-type                Authentication type for the app (e.g. 'basic', 'reentranceTicket'). Required for 'reentranceTicket'.
   --transport <transport-request>      Transport number to record the change in the ABAP system
   --create-transport                   Create a transport request during deployment

packages/deploy-tooling/test/unit/cli/index.test.ts

@@ -81,6 +81,7 @@ describe('cli', () => {
         const cliCmdWithUaa = [...cliCmd, '--cloud-service-env', '--service', '/bc/my/uaa/deploy/service'];
         const cliCmdWithAuthType = [...cliCmd, '--authentication-type', 'reentranceTicket'];
         const cliCmdWithConnectPath = [...cliCmd, '--connect-path', '/my/connect/path'];
+        const cliCmdWithBasicAuth = [...cliCmd, '--username', 'env:username', '--password', 'env:password'];
 
         test.each([
             {
@@ -127,11 +128,19 @@ describe('cli', () => {
                 writeFileSyncCalled: 0,
                 deployFn: mockedUi5RepoService.deploy,
                 object: { connectPath: '/my/connect/path' }
+            },
+            {
+                params: cliCmdWithBasicAuth,
+                writeFileSyncCalled: 0,
+                deployFn: mockedUi5RepoService.deploy,
+                object: { retry: false, strictSsl: false }
             }
         ])(
             'successful deploy with different options %s',
             async ({ params, writeFileSyncCalled, object, provider, deployFn }) => {
                 process.argv = params;
+                delete process.env.username;
+                delete process.env.password;
                 await runDeploy();
                 expect(deployFn).toHaveBeenCalled();
                 if (provider) {