isabella232 / devops-cm-client

Simple command line interface to handle basic change management related actions via ODATA requests.

Description

Simple command line interface to handle basic change management related actions in SAP Solution Manager or with CTS via ODATA requests. The client is intended to be used in continuous integration and continuous delivery scenarios and supports only the actions necessary within those scenarios. See section Usage for more details.

Requirements

SAP Solution Manager Functionality

• SAP Solution Manager 7.2 SP6, SP7 -> cm_client v1.x
• SAP Solution Manager 7.2 SP 8 and higher -> cm_client v2.0

CTS without SAP Solution Manager

AS ABAP Version	Service Pack
7.50	>= SP12
7.51	>= SP07
7.52	>= SP03
7.53	>= SP01
7.54	>= SP01

• SAPUI 7.53

General Requirements

• JDK 8 to build this project (to run the client JRE 8 is sufficient) OR
• a Docker environment to run the Docker image

Download and Installation

This command line client can be consumed either as a Java application from maven.org or as a Docker image from hub.docker.com.

The public key for verifing the artifacts is available here

Using the Docker Image

On a Linux machine, you can run:

docker run --rm ppiper/cm-client cmclient --help

This prints the help information of the CM Client. For a comprehensive overview of available commands, please read the usage information below.

How to Build the Docker Image

The Dockerfile is located in a designated branch dockerfile. After checking out the branch, you can run: docker build -t cm-client .

Using the Java Application from maven.org

• Download the command line interface package from maven.org.

• Extract the command line interface package into a suitable folder.

  Example:

     CM_VERSION=2.0.1
     export CMCLIENT_HOME=`pwd`/cm_client
     export PATH=${CMCLIENT_HOME}/bin:${PATH}
     mkdir -p ${CMCLIENT_HOME}
     curl "https://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli/${CM_VERSION}/dist.cli-${CM_VERSION}.tar.gz"  \
     |tar -C ${CMCLIENT_HOME} -xvf -
     cmclient --version
     cmclient --help
  

It is recommanded to define CMCLIENT_HOME and PATH in ~/.bash_profile or in any other suitable way.

Usage of the CLI

<CMD> [COMMON_OPTIONS...] <subcommand> [SUBCOMMAND_OPTIONS] <parameters...>

To pass additional Java options to the command (for example, another truststore), set the environment variable CMCLIENT_OPTS

Option	Description
-t, --backend-type	SOLMAN or CTS
-e, --endpoint <arg>	Service endpoint
-h, --help	Prints this help.
-p, --password <arg>	Service password, if '-' is provided, password will be read from stdin.
-u, --user <arg>	Service user.
-v, --version	Prints the version.

Subcommand	Backend Type	Description
create-transport	SOLMAN	Creates a new transport entity.
get-transport-description	SOLMAN	Returns the description of the transport.
get-transport-owner	SOLMAN	Returns the owner of the transport.
get-transports	SOLMAN	Returns the IDs of the transports.
is-change-in-development	SOLMAN	Returns 'true' if the change is in development.
is-transport-modifiable	SOLMAN	Returns 'true' if the transport is modifiable.
release-transport	SOLMAN	Releases the transport.
upload-file-to-transport	SOLMAN	Uploads a file to a transport.
get-transport-development-system	SOLMAN	Returns the target system of the transport.
create-transport	CTS	Creates a new transport entity.
export-transport	CTS	Exports a transport entity.
get-transport-description	CTS	Returns the description of the transport.
get-transport-owner	CTS	Returns the owner of the transport.
get-transport-status	CTS	Returns the status of the transport.
get-transport-target-system	CTS	Returns the target system of the transport.
get-transport-type	CTS	Returns the type of the transport.
import-transport	CTS	Imports a transport entity.
is-transport-modifiable	CTS	Returns 'true' if the transport is modifiable.
upload-file-to-transport	CTS	Uploads a file to a transport.

For more information about subcommands and subcommand options run <CMD> <subcommand> --help.

How to obtain support

Feel free to open new issues for feature requests, bugs or general feedback on the GitHub issues page of this project.

Contributing

Read and understand our contribution guidelines before opening a pull request.

Release Notes

The release notes are available here.