feat: Added levels of connectivity to connect command #179

jirihnidek · 2024-12-09T16:39:31Z

Card ID: CCT-1005
First step of levels of connectivity
When connect command is used, then it is possible to
enabled or disable three features using command line
options --enable-feature or --disable-feature. Following
features are supported
- content
- analytics
- remote-management
Added checks for allowed combination of CLI options
Modified UI little bit to be able to visualize that
feature was not started
Output to JSON format is still supported
When machine readable format is used, then add information
about enabled/disabled content to generated JSON file
When machine readable output is used, then list of
enabled/disable features is added to the generated JSON doc
Unified UI for colorful and not colorful mode
Changed UI for disconnect command to looks similar to connect command
Connecting looks like this in interactive mode:

Connecting localhost to Red Hat.
This might take a few seconds.

Features preferences: [✓]content, [✓]analytics, [✓]remote-management

 [✓] This system is already connected to Red Hat Subscription Management
  [✓] Content ... Red Hat repository file generated
  [✓] Analytics ... Connected to Red Hat Insights
  [✓] Remote Management ... Activated the yggdrasil service

Successfully connected to Red Hat!

Manage your connected systems: https://red.ht/connector

* Card ID: CCT-1005 * First step of levels of connectivity * When connect command is used, then it is possible to enabled or disable three features using command line options --enable-feature or --disable-feature. Following features are supported - content - analytics - remote-mamanagement * Added checks for allowed combination of CLI options * Modified UI little bit to be able to visualize that feature was not started * Output to JSON format is still supported

* Card ID: CCT-1005 * When machine readable format is used, then add information about enabled/disabled content to generated JSON file

jirihnidek · 2024-12-09T16:41:18Z

Open question:

How should we list enabled/disabled features in generated JSON document?
Current output looks like this:

{
    "hostname": "localhost",
    "uid": 0,
    "enabled_features": [
        "analytics",
        "remote-management"
    ],
    "disabled_features": [
        "content"
    ],
    "rhsm_connected": true,
    "content_enabled": false,
    "insights_connected": true,
    "yggdrasil_started": true
}

Another possible solution could be following:

{
    "hostname": "localhost",
    "uid": 0,
    "features": {
        "enabled": [
            "analytics",
            "remote-management"
        ],
        "disabled": [
            "content"
        ],
    },
    "rhsm_connected": true,
    "content_enabled": false,
    "insights_connected": true,
    "yggdrasil_started": true
}

Or we can introduce something like this. This has potential to add there more attributes in the future:

{
    "hostname": "localhost",
    "uid": 0,
    "features": {
        "content": {
            "enabled": false,
        },
        "analytics": {
            "enabled": true,
        },
        "remote-management": {
            "enabled": true,
        },
    },
    "rhsm_connected": true,
    "content_enabled": false,
    "insights_connected": true,
    "yggdrasil_started": true
}

TODO:

Allow to enabled/disable features in interactive mode, when user has to input username & password (this should be part of another PR)

* Card ID: CCT-1005 * When machine readable output is used (JSON format), then include list of enabled and list of disabled features in JSON document

m-horky

The patch seems solid. I won't comment much on the code itself; we'll likely see further changes done in near future as we stabilize it before new features come.

The output seems to jump around, were the two spaces intentional?

$ rhc connect --disable-feature analytics
...
 [✓] Connected to Red Hat Subscription Management
  [✓] Content ... Red Hat repository file generated
 [ ] Analytics ... Connecting to Red Hat Insights disabled
  [✓] Remote Management ... Activated the yggdrasil service

When disconnecting, Insights reported status 1 even though we should have detected we're (already) unregistered:

 [✓] Deactivated the yggdrasil service
 [𐄂] Cannot disconnect from Red Hat Insights: exit status 1
 [✓] Disconnected from Red Hat Subscription Management

The same goes for disconnection: with nothing connected in the first place, the output doesn't say yggdrasil wasn't enabled in the first place. That's a non-blocking note, but it feels strange.

$ rhc connect --enable-feature remote-management --disable-feature remote-management
cannot enable feature: "remote-management": feature "remote-management" explicitly disabled

Are we able to display something prettier and more human-understandable? Non-blocking note, may be addressed later.

m-horky · 2024-12-17T13:06:35Z

connect_cmd.go

+			if uiSettings.isMachineReadable {
+				connectResult.EnabledFeatures = append(connectResult.EnabledFeatures, feature.ID)
+			}
+			featuresStr = append(featuresStr, "["+symbolOK+"]"+feature.ID)


I think there should be a space between the checkbox and the text.

m-horky · 2024-12-17T13:06:41Z

connect_cmd.go

+			if uiSettings.isMachineReadable {
+				connectResult.DisabledFeatures = append(connectResult.EnabledFeatures, feature.ID)
+			}
+			featuresStr = append(featuresStr, "[ ]"+feature.ID)


I think there should be a space between the checkbox and the text.

m-horky · 2024-12-17T13:22:23Z

Or we can introduce something like this. This has potential to add there more attributes in the future:

{
    "hostname": "localhost",
    "uid": 0,
    "features": {
        "content": {
            "enabled": false,
        },
        "analytics": {
            "enabled": true,
        },
        "remote-management": {
            "enabled": true,
        },
    },
    "rhsm_connected": true,
    "content_enabled": false,
    "insights_connected": true,
    "yggdrasil_started": true
}

I like the nested approach. Would it make sense to move the _connected, _enabled keys into the features map?

"features": {
  "content": {
    "enabled": true,
    "connected": true,
  },
  "analytics": {
    "enabled": true,
    "connected": false,
  },
  ...
}

subpop

One small change I think we can make. I will test the behavior of this branch and follow up with another review.

subpop · 2025-01-02T16:25:35Z

rhsm.go

+	var enabledContentStr string
+	if enableContent {
+		enabledContentStr = "true"
+	} else {
+		enabledContentStr = "false"
+	}


I believe this could be simplified into a single Sprintf statement, using the Stringer implementation of the bool type.

Suggested change

var enabledContentStr string

if enableContent {

enabledContentStr = "true"

} else {

enabledContentStr = "false"

}

enableContentStr := fmt.Sprintf("%v", enableContent)

subpop · 2025-01-02T16:53:22Z

main.go

@@ -157,6 +157,16 @@ func main() {
 					Usage:   "register with `KEY`",
 					Aliases: []string{"a"},
 				},
+				&cli.StringSliceFlag{
+					Name:    "enable-feature",
+					Usage:   "enable feature during connection",


Using the backtick notation in the usage string will encode it in help output,
making the output consistent with other, existing flags.

Suggested change

Usage: "enable feature during connection",

Usage: "enable `FEATURE` during connection",

subpop · 2025-01-02T16:53:43Z

main.go

+				},
+				&cli.StringSliceFlag{
+					Name:    "disable-feature",
+					Usage:   "disable feature during connection",


Suggested change

Usage: "disable feature during connection",

Usage: "disable `FEATURE` during connection",

subpop · 2025-01-02T17:01:10Z

rhsm.go

 	if err := privConn.Object(
 		"com.redhat.RHSM1",
 		"/com/redhat/RHSM1/Register").Call(
 		"com.redhat.RHSM1.Register.RegisterWithActivationKeys",
 		dbus.Flags(0),
 		orgID,
 		activationKeys,
-		map[string]string{},
+		map[string]string{"enable_content": enabledContentStr},


When I try to register with my activation key, I get the following error:

[link@lima-rhel-10 rhc]$ sudo ./builddir/rhc connect -o 12671438 -a developer Connecting lima-rhel-10 to Red Hat. This might take a few seconds. Features preferences: [✓]content, [✓]analytics, [✓]remote-management [𐄂] Cannot connect to Red Hat Subscription Management [𐄂] Skipping generation of Red Hat repository file [𐄂] Skipping connection to Red Hat Insights [𐄂] Skipping activation of yggdrasil service Successfully connected to Red Hat! Manage your connected systems: https://red.ht/connector The following errors were encountered during connect: TYPE STEP ERROR ERROR rhsm cannot connect to Red Hat Subscription Management: error: Unknown arguments: dict_keys(['enable_content'])

Does the D-Bus method RegisterWithActivationKeys not accept 'enable_content' as
a parameter option? If so, does this mean that we cannot opt out of content if
registering with an activation key?

subpop · 2025-01-02T17:04:56Z

connect_cmd.go

-			connectResult.InsightsConnected = true
-			interactivePrintf("%v Connected to Red Hat Insights\n", uiSettings.iconOK)
+			start = time.Now()
+			err = showProgress(" Connecting to Red Hat Insights...", registerInsights)


With the introduction of the space-indented results printout in the interactive
mode, the in-progress spinner looks awkward.

[✓] Connected to Red Hat Subscription Management [✓] Content ... Red Hat repository file generated / Connecting to Red Hat Insights...

Can we put that spinner inside brackets too? That can reduce the bouncing back
and forth as new lines are printed.

[✓] Connected to Red Hat Subscription Management [✓] Content ... Red Hat repository file generated [/] Connecting to Red Hat Insights...

subpop · 2025-01-02T17:07:09Z

connect_cmd.go

-		durations[ServiceName] = time.Since(start)
-		interactivePrintf("\nSuccessfully connected to Red Hat!\n")
+	} else {
+		interactivePrintf(" [ ] Management .... Starting %s service disabled\n", ServiceName)


When I disabled the 'remote-management' feature, it looks like the space-indents
were missing one:

[✓] Connected to Red Hat Subscription Management [✓] Content ... Red Hat repository file generated [✓] Analytics ... Connected to Red Hat Insights [ ] Management .... Starting yggdrasil service disabled

jirihnidek added 2 commits December 9, 2024 16:21

feat: Added information about enabled content to generated JSON

eb25fd1

* Card ID: CCT-1005 * When machine readable format is used, then add information about enabled/disabled content to generated JSON file

feat: Added list of enabled/disable features to JSON doc

170304e

* Card ID: CCT-1005 * When machine readable output is used (JSON format), then include list of enabled and list of disabled features in JSON document

m-horky requested changes Dec 17, 2024

View reviewed changes

subpop requested changes Jan 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Added levels of connectivity to connect command #179

feat: Added levels of connectivity to connect command #179

jirihnidek commented Dec 9, 2024 •

edited

Loading

jirihnidek commented Dec 9, 2024 •

edited

Loading

m-horky left a comment

m-horky Dec 17, 2024

m-horky Dec 17, 2024

m-horky commented Dec 17, 2024

subpop left a comment

subpop Jan 2, 2025

subpop Jan 2, 2025

subpop Jan 2, 2025

subpop Jan 2, 2025

subpop Jan 2, 2025

subpop Jan 2, 2025

	Usage: "enable feature during connection",
	Usage: "enable `FEATURE` during connection",

	Usage: "disable feature during connection",
	Usage: "disable `FEATURE` during connection",

feat: Added levels of connectivity to connect command #179

Are you sure you want to change the base?

feat: Added levels of connectivity to connect command #179

Conversation

jirihnidek commented Dec 9, 2024 • edited Loading

jirihnidek commented Dec 9, 2024 • edited Loading

m-horky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-horky commented Dec 17, 2024

subpop left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jirihnidek commented Dec 9, 2024 •

edited

Loading

jirihnidek commented Dec 9, 2024 •

edited

Loading