Add BTP CLI #5473

Dannick-debug · 2025-09-08T12:42:29Z

Pull Request Description

Objective

This pull request introduces functions to facilitate the use of the BTP CLI. The key functionalities added include:

Connecting to the BPI Cockpit (login/logout)
Creating, retrieving, and deleting service instances
Creating, retrieving, and deleting service bindings

Key Improvements

CommandBuilder Implementation: A CommandBuilder has been developed to streamline script creation, ensuring efficient command handling.
Execution Mechanisms: Two execution mechanisms have been introduced:
- Synchronous Execution (Run): Enables concurrent task execution without blocking the main process.
- Asynchronous Execution (RunSync): Incorporates a polling mechanism to verify the success of BTP actions at regular intervals.

Synchronous Execution

Currently, BTP actions do not support direct synchronous execution. To address this, a polling mechanism has been implemented to continuously check the status of actions, ensuring they are completed successfully.

Checklist

Tests: Comprehensive tests have been conducted to ensure functionality and reliability.

…-BTP-API

…as response format, - additional tests

…n, - enable verbose setting,

…-BTP-API

cla-assistant · 2025-09-08T12:42:45Z

All committers have signed the CLA.

…rvice instance checks

nayyer28

lgtm!

doldsimo · 2025-09-08T14:02:47Z

pkg/btp/executor.go

+/*
+@param timeout : in seconds
+@param pollInterval : in seconds
+@param negativeCheck : set to false if you whant to check the negation of the response of `cmdCheck`


Suggested change

@param negativeCheck : set to false if you whant to check the negation of the response of `cmdCheck`

@param negativeCheck : set to false if you want to check the negation of the response of `cmdCheck`

DanielMieg · 2025-09-08T15:16:29Z

Maybe you could consider some naming changes. I noticed the following things:

btp_test.go tests executor.go
The mock is called btp_runner.go but mocks the "ExecRunner"
Some files use camel case and some use snake case (not concerning the _test suffix)
If a function returns a boolean, the function is (with some naming conventions) named as a question:

CheckServiceInstanceCreated -> IsServiceInstanceCreated

Could you add unit tests for the rest of the files? (checkFunctions.go & command_builder.go). Maybe that was your plan anyway, as this is still a draft

…ency; add BTP command builder and mock executor

…letion checks

…nstance tests

DanielMieg · 2025-09-30T07:53:04Z

pkg/btputils/structures.go

@@ -0,0 +1,118 @@
+package btputils


Looks good 👍. One small thing: I would move structures.go to the btp package.I think it does not make sense to create a whole package just for some structures

DanielMieg

see comment

…mprove structure

sonarqubecloud · 2025-09-30T13:28:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

c0dev0id · 2025-10-15T09:36:49Z

We were just about to request an option to create service bindings/instances on the BTP without CF and then found this PR.
Thanks for the work! (sorry, can't comment using my work account for some reason...)

pkg/btp/authentication.go

pkg/btp/checkFunctions.go

o-liver · 2025-10-22T07:40:15Z

pkg/btp/commandBuilder.go

+	if len(b.params) > 0 {
+		cmd += " " + strings.Join(b.params, " ")
+	}
+	return cmd, nil


I see this command is put together with spaces. How is this executed? Not in a shell right? As I know it we should pass these as a list to an executor, to prevent command injections. Check other such commands e.g. https://github.com/SAP/jenkins-library/blob/master/pkg/npm/npm.go#L129

You are right.
Now we will only use Array of string in the builder (no more concatenations)

pkg/btp/executor.go

pkg/btp/services.go

…for command scripts

… security

…ed consistency

…inding checks

o-liver

Looks good to me. Only minor suggestions made, take it or leave.

o-liver · 2025-11-03T12:47:52Z

pkg/btp/executor_test.go

+			"btp check": `dummy
+							dummy
+
+							OK`,


why such a weird string?

Suggested change

"btp check": `dummy

dummy

OK`,

"btp check": "OK",

corrected 👍🏾

o-liver · 2025-11-03T12:49:37Z

pkg/btp/services_test.go

+			StdoutReturn: map[string]string{
+				"btp login .*": "Authentication successful",
+				"btp get services/binding": fmt.Sprintf(`
+{
+  "id": "xxxx",
+  "name": "%s",
+  "ready": true
+}`, btpConfig.BindingName),
+			},


this json some extra spaces should not matter:

Suggested change

StdoutReturn: map[string]string{

"btp login .*": "Authentication successful",

"btp get services/binding": fmt.Sprintf(`

{

"id": "xxxx",

"name": "%s",

"ready": true

}`, btpConfig.BindingName),

},

StdoutReturn: map[string]string{

"btp login .*": "Authentication successful",

"btp get services/binding": fmt.Sprintf(`

{

"id": "xxxx",

"name": "%s",

"ready": true

}`, btpConfig.BindingName),

},

corrected 👍🏾

o-liver · 2025-11-03T12:49:58Z

pkg/btp/services_test.go

+{
+  "id": "xxxx",
+  "name": "%s",
+  "ready": true
+}`, btpConfig.BindingName),


same as above

corrected 👍🏾

o-liver · 2025-11-03T12:50:23Z

pkg/btp/services_test.go

+{
+  "error": "BadRequest",
+  "description": "Could not find such binding"
+}`),


again a json string, which could be indented nicer

corrected 👍🏾

…ance tests

DanielMieg · 2025-11-03T14:19:42Z

/it

o-liver · 2025-11-05T09:24:33Z

/it-go

sonarqubecloud · 2025-11-05T09:26:25Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Dannick-debug added 18 commits March 27, 2025 13:28

Command Builder for BTP CLI

fc45f88

Executer + Mock

086d0de

Test of the Executer

57ec748

BTP Auth functions + Test

ac69080

BTP Service functions + Test

8265565

Merge remote-tracking branch 'origin/master' into replace-CF-CLI-with…

30a9b01

…-BTP-API

- refactor to executor, - delete logincheck, - setConfig, - use json …

a96b67c

…as response format, - additional tests

remove unnecessary varaible creation

94915a3

- get TimeOut & PollInterval from options parameter, - remove loggedI…

a8b5c62

…n, - enable verbose setting,

change files name to lower case

03fac2b

Delete pkg/btp/Authentication.go

46e01ce

Delete pkg/btp/Authentication_test.go

a9345d5

Delete pkg/btp/Services.go

c39bfe8

put struc at the end in each files

389c047

Merge branch 'master' into replace-CF-CLI-with-BTP-API

7c40b0f

remove "ServiceInstance" from struct "CreateServiceInstanceOptions"

5b1680e

Merge remote-tracking branch 'origin/master' into replace-CF-CLI-with…

bdd3870

…-BTP-API

Merge remote-tracking branch 'origin/master' into replace-CF-CLI-with…

63a7b27

…-BTP-API

DanielMieg added the ABAP label Sep 8, 2025

DanielMieg requested a review from doldsimo September 8, 2025 12:55

feat: refactor BTP command execution to use RunSyncOptions and add se…

325312d

…rvice instance checks

nayyer28 approved these changes Sep 8, 2025

View reviewed changes

doldsimo reviewed Sep 8, 2025

View reviewed changes

Dannick-debug added 4 commits September 18, 2025 12:56

feat: rename service instance and binding check functions for consist…

15ec12e

…ency; add BTP command builder and mock executor

feat: add unit tests for service instance and binding creation and de…

0adc42f

…letion checks

feat: add comprehensive tests for BTP command builder functionality

f316260

refactor: remove unused test URL constants from service binding and i…

4b3dbad

…nstance tests

DanielMieg reviewed Sep 30, 2025

View reviewed changes

feat: refactor BTP executor and tests to remove mock dependency and i…

4464a85

…mprove structure

Dannick-debug marked this pull request as ready for review September 30, 2025 13:28

Dannick-debug requested a review from a team as a code owner September 30, 2025 13:28

DanielMieg requested a review from o-liver September 30, 2025 13:29

DanielMieg requested a review from tiloKo October 13, 2025 13:43

DanielMieg changed the title ~~Replace cf cli with btp api~~ Add BTP CLI Oct 13, 2025

o-liver reviewed Oct 22, 2025

View reviewed changes

Dannick-debug added 4 commits October 30, 2025 16:12

feat: update BTP command builder and executor to use array of string …

da06059

…for command scripts

refactor: remove password logging from BTP login process for enhanced…

12274df

… security

refactor: update command execution to use array of strings for improv…

669f5ec

…ed consistency

refactor: remove unnecessary logout calls from service instance and b…

a218786

…inding checks

Dannick-debug requested review from DanielMieg and o-liver October 30, 2025 16:06

o-liver approved these changes Nov 3, 2025

View reviewed changes

Dannick-debug and others added 2 commits November 3, 2025 14:12

refactor: clean up test output formatting in service binding and inst…

39014d8

…ance tests

Merge branch 'master' into replace-CF-CLI-with-BTP-API

1780b7b

Merge branch 'master' into replace-CF-CLI-with-BTP-API

320fb3e

DanielMieg merged commit a8e29db into SAP:master Nov 5, 2025
13 checks passed

	@param negativeCheck : set to false if you whant to check the negation of the response of `cmdCheck`
	@param negativeCheck : set to false if you want to check the negation of the response of `cmdCheck`

Add BTP CLI #5473

Add BTP CLI #5473

Uh oh!

Conversation

Dannick-debug commented Sep 8, 2025

Pull Request Description

Objective

Key Improvements

Synchronous Execution

Checklist

Uh oh!

cla-assistant bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nayyer28 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielMieg commented Sep 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielMieg left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 30, 2025

Quality Gate passed

Uh oh!

c0dev0id commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

o-liver left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielMieg commented Nov 3, 2025

Uh oh!

o-liver commented Nov 5, 2025

Uh oh!

sonarqubecloud bot commented Nov 5, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

cla-assistant bot commented Sep 8, 2025 •

edited

Loading

c0dev0id commented Oct 15, 2025 •

edited

Loading