Skip to content

Add localization support #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mjcr99 wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add localization support #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4098e9
feat(i18n): use snapcore/go-gettext to implement localization support
mjcr99 Feb 26, 2026
f4df72c
feat(i18n): wrap printable chains to enable .pot file extraction and …
mjcr99 Feb 26, 2026
cf8353e
feat(i18n): extracted .pot file
mjcr99 Feb 26, 2026
8c6aabf
fix(i18n): resolve non-constant format string errors in localized code
mjcr99 Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion cmd/rhc/canonical_facts_cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ package main

import (
"encoding/json"
"errors"
"fmt"

"github.com/redhatinsights/rhc/internal/canonical_facts"
"github.com/redhatinsights/rhc/internal/localization"
"github.com/urfave/cli/v2"
)

Expand All @@ -14,7 +16,7 @@ func canonicalFactAction(_ *cli.Context) error {
// NOTE: CLI context is not useful for anything
facts, err := canonical_facts.GetCanonicalFacts()
if err != nil {
return cli.Exit(fmt.Errorf("cannot generate canonical facts: %v", err), 1)
return cli.Exit(errors.New(localization.TF("cannot generate canonical facts: %v", err)), 1)
}
data, err := json.MarshalIndent(facts, "", " ")
if err != nil {
Expand Down
86 changes: 47 additions & 39 deletions cmd/rhc/connect_cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@ package main

import (
"encoding/json"
"errors"
"fmt"
"log/slog"
"os"
"strings"
"time"

"github.com/redhatinsights/rhc/internal/features"
"github.com/redhatinsights/rhc/internal/localization"
"github.com/redhatinsights/rhc/internal/rhsm"
"github.com/urfave/cli/v2"

Expand Down Expand Up @@ -53,7 +55,7 @@ func (connectResult *ConnectResult) Error() string {
case "":
break
default:
result = "error: unsupported document format: " + connectResult.format
result = localization.TF("error: unsupported document format: %s", connectResult.format)
}
return result
}
Expand All @@ -80,19 +82,21 @@ func (connectResult *ConnectResult) TryRegisterRHSM(ctx *cli.Context) {
returnedMsg, err := rhsm.RegisterRHSM(ctx, features.ContentFeature.Enabled)
if err != nil {
connectResult.RHSMConnected = false
connectResult.RHSMConnectError = fmt.Sprintf("cannot connect to Red Hat Subscription Management: %s", err)
connectResult.RHSMConnectError = localization.TF("cannot connect to Red Hat Subscription Management: %s", err)
connectResult.Features.Content.Successful = false
slog.Error(connectResult.RHSMConnectError)
ui.Printf(
"%s[%v] Cannot connect to Red Hat Subscription Management\n",
"%s[%v] %s\n",
ui.Indent.Small,
ui.Icons.Error,
localization.T("Cannot connect to Red Hat Subscription Management"),
)
slog.Warn("Skipping generation of redhat.repo (RHSM registration failed)")
ui.Printf(
"%s[%v] Skipping generation of Red Hat repository file\n",
"%s[%v] %s\n",
ui.Indent.Medium,
ui.Icons.Error,
localization.T("Skipping generation of Red Hat repository file"),
)
} else {
connectResult.RHSMConnected = true
Expand All @@ -101,11 +105,11 @@ func (connectResult *ConnectResult) TryRegisterRHSM(ctx *cli.Context) {
if features.ContentFeature.Enabled {
connectResult.Features.Content.Successful = true
slog.Info("redhat.repo has been generated")
ui.Printf("%s[%v] Content ... Red Hat repository file generated\n", ui.Indent.Medium, ui.Icons.Ok)
ui.Printf("%s[%v] %s\n", ui.Indent.Medium, ui.Icons.Ok, localization.T("Content ... Red Hat repository file generated"))
} else {
connectResult.Features.Content.Successful = false
slog.Info("redhat.repo not generated (content feature disabled)")
ui.Printf("%s[ ] Content ... Red Hat repository file not generated\n", ui.Indent.Medium)
ui.Printf("%s[ ] %s\n", ui.Indent.Medium, localization.T("Content ... Red Hat repository file not generated"))
}
}
}
Expand All @@ -117,37 +121,39 @@ func (connectResult *ConnectResult) TryRegisterInsightsClient() {
if !features.AnalyticsFeature.Enabled {
connectResult.Features.Analytics.Successful = false
slog.Info("Connecting to Red Hat Lightspeed disabled (analytics feature disabled)")
ui.Printf("%s[ ] Analytics ... Connecting to Red Hat Lightspeed (formerly Insights) disabled\n", ui.Indent.Medium)
ui.Printf("%s[ ] %s\n", ui.Indent.Medium, localization.T("Analytics ... Connecting to Red Hat Lightspeed (formerly Insights) disabled"))
return
}

if connectResult.RHSMConnectError != "" {
slog.Warn("Skipping connection to Red Hat Lightspeed (RHSM registration failed)", "rhsm_error", connectResult.RHSMConnectError)
ui.Printf(
"%s[%v] Skipping connection to Red Hat Lightspeed (formerly Insights)\n",
"%s[%v] %s\n",
ui.Indent.Medium,
ui.Icons.Error,
localization.T("Skipping connection to Red Hat Lightspeed (formerly Insights)"),
)
return
}

slog.Info("Connecting to Red Hat Lightspeed")
err := ui.Spinner(datacollection.RegisterInsightsClient, ui.Indent.Medium, "Connecting to Red Hat Lightspeed (formerly Insights)...")
err := ui.Spinner(datacollection.RegisterInsightsClient, ui.Indent.Medium, localization.T("Connecting to Red Hat Lightspeed (formerly Insights)..."))
if err != nil {
connectResult.Features.Analytics.Successful = false
connectResult.Features.Analytics.Error = fmt.Sprintf("cannot connect to Red Hat Lightspeed (formerly Insights): %v", err)
slog.Error(fmt.Sprintf("cannot connect to Red Hat Lightspeed: %v", err))
connectResult.Features.Analytics.Error = localization.TF("cannot connect to Red Hat Lightspeed (formerly Insights): %v", err)
slog.Error(localization.TF("cannot connect to Red Hat Lightspeed: %v", err))
ui.Printf(
"%s[%v] Analytics ... Cannot connect to Red Hat Lightspeed (formerly Insights)\n",
"%s[%v] %s\n",
ui.Indent.Medium,
ui.Icons.Error,
localization.T("Analytics ... Cannot connect to Red Hat Lightspeed (formerly Insights)"),
)
return
}

connectResult.Features.Analytics.Successful = true
slog.Debug("Connected to Red Hat Lightspeed")
ui.Printf("%s[%v] Analytics ... Connected to Red Hat Lightspeed (formerly Insights)\n", ui.Indent.Medium, ui.Icons.Ok)
ui.Printf("%s[%v] %s\n", ui.Indent.Medium, ui.Icons.Ok, localization.T("Analytics ... Connected to Red Hat Lightspeed (formerly Insights)"))
}

// TryActivateServices will attempt to activate the yggdrasil service.
Expand All @@ -157,13 +163,13 @@ func (connectResult *ConnectResult) TryActivateServices() {
if !features.ManagementFeature.Enabled {
connectResult.Features.RemoteManagement.Successful = false
if features.ManagementFeature.Reason != "" {
infoMsg := fmt.Sprintf("Starting yggdrasil service disabled (%s)", features.ManagementFeature.Reason)
infoMsg := localization.TF("Starting yggdrasil service disabled (%s)", features.ManagementFeature.Reason)
slog.Info(infoMsg)
ui.Printf("%s[ ] Management .... %s\n", ui.Indent.Medium, infoMsg)
ui.Printf("%s[ ] %s\n", ui.Indent.Medium, infoMsg)
} else {
infoMsg := "Starting yggdrasil service disabled"
infoMsg := localization.T("Starting yggdrasil service disabled")
slog.Info(infoMsg)
ui.Printf("%s[ ] Management .... %s\n", ui.Indent.Medium, infoMsg)
ui.Printf("%s[ ] %s\n", ui.Indent.Medium, infoMsg)
}
return
}
Expand All @@ -175,31 +181,33 @@ func (connectResult *ConnectResult) TryActivateServices() {
"rhsm_error", connectResult.RHSMConnectError,
)
ui.Printf(
"%s[%v] Skipping activation of yggdrasil service\n",
"%s[%v] %s\n",
ui.Indent.Medium,
ui.Icons.Error,
localization.T("Skipping activation of yggdrasil service"),
)
return
}

slog.Info("Activating yggdrasil service")
err := ui.Spinner(remotemanagement.ActivateServices, ui.Indent.Medium, " Activating the yggdrasil service")
err := ui.Spinner(remotemanagement.ActivateServices, ui.Indent.Medium, localization.T(" Activating the yggdrasil service"))
if err != nil {
connectResult.Features.RemoteManagement.Successful = false
connectResult.Features.RemoteManagement.Error = fmt.Sprintf("cannot activate the yggdrasil service: %v", err)
connectResult.Features.RemoteManagement.Error = localization.TF("cannot activate the yggdrasil service: %v", err)
slog.Error(connectResult.Features.RemoteManagement.Error)
ui.Printf(
"%s[%v] Remote Management ... Cannot activate the yggdrasil service\n",
"%s[%v] %s\n",
ui.Indent.Medium,
ui.Icons.Error,
localization.T("Remote Management ... Cannot activate the yggdrasil service"),
)
return
}

connectResult.Features.RemoteManagement.Successful = true
infoMsg := "Activated the yggdrasil service"
infoMsg := localization.T("Activated the yggdrasil service")
slog.Debug(infoMsg)
ui.Printf("%s[%v] Remote Management ... %s\n", ui.Indent.Medium, ui.Icons.Ok, infoMsg)
ui.Printf("%s[%v] %s\n", ui.Indent.Medium, ui.Icons.Ok, localization.T("Remote Management ... Activated the yggdrasil service"))
}

// beforeConnectAction ensures that user has supplied correct CLI options
Expand All @@ -221,13 +229,13 @@ func beforeConnectAction(ctx *cli.Context) error {
uuid, err := rhsm.GetConsumerUUID()
if err != nil {
return cli.Exit(
fmt.Sprintf("unable to get consumer UUID: %s", err),
localization.TF("unable to get consumer UUID: %s", err),
ExitCodeSoftware,
)
}
if uuid != "" {
slog.Info("Consumer UUID is set, system is already connected")
return cli.Exit("this system is already connected", ExitCodeUsage)
return cli.Exit(localization.T("this system is already connected"), ExitCodeUsage)
}

username := ctx.String("username")
Expand All @@ -241,23 +249,23 @@ func beforeConnectAction(ctx *cli.Context) error {
if len(activationKeys) > 0 {
if username != "" {
exitErr := cli.Exit(
"--username and --activation-key can not be used together",
localization.T("--username and --activation-key can not be used together"),
ExitCodeUsage,
)
return exitErr

}
if password != "" {
exitErr := cli.Exit(
"--password and --activation-key can not be used together",
localization.T("--password and --activation-key can not be used together"),
ExitCodeUsage,
)
return exitErr

}
if organization == "" {
exitErr := cli.Exit(
"--organization is required, when --activation-key is used",
localization.T("--organization is required, when --activation-key is used"),
ExitCodeUsage,
)
return exitErr
Expand All @@ -269,7 +277,7 @@ func beforeConnectAction(ctx *cli.Context) error {
if !ui.IsInteractive() {
if (username == "" || password == "") && (len(activationKeys) == 0 || organization == "") {
exitErr := cli.Exit(
"--username/--password or --organization/--activation-key are required when a machine-readable format is used",
localization.T("--username/--password or --organization/--activation-key are required when a machine-readable format is used"),
ExitCodeUsage,
)
return exitErr
Expand All @@ -283,7 +291,7 @@ func beforeConnectAction(ctx *cli.Context) error {

if !features.ContentFeature.Enabled && len(contentTemplates) > 0 {
return cli.Exit(
"'--content-template' can not be used together with '--disable-feature content'",
localization.T("'--content-template' can not be used together with '--disable-feature content'"),
ExitCodeUsage,
)
}
Expand All @@ -307,15 +315,15 @@ func connectAction(ctx *cli.Context) error {

uid := os.Getuid()
if uid != 0 {
errMsg := "non-root user cannot connect system"
errMsg := localization.T("non-root user cannot connect system")
exitCode := 1
slog.Error(errMsg)
if ui.IsOutputMachineReadable() {
connectResult.UID = uid
connectResult.UIDError = errMsg
return cli.Exit(connectResult, exitCode)
} else {
return cli.Exit(fmt.Errorf("error: %s", errMsg), exitCode)
return cli.Exit(errors.New(localization.TF("error: %s", errMsg)), exitCode)
}
}

Expand All @@ -325,7 +333,7 @@ func connectAction(ctx *cli.Context) error {
}
if err != nil {
exitCode := 1
slog.Error(fmt.Sprintf("Error retrieving system hostname: %v", err))
slog.Error(localization.TF("Error retrieving system hostname: %v", err))
if ui.IsOutputMachineReadable() {
connectResult.HostnameError = err.Error()
return cli.Exit(connectResult, exitCode)
Expand All @@ -334,7 +342,7 @@ func connectAction(ctx *cli.Context) error {
}
}

ui.Printf("Connecting %v to Red Hat.\nThis might take a few seconds.\n\n", hostname)
ui.Printf("%s", localization.TF("Connecting %v to Red Hat.\nThis might take a few seconds.\n\n", hostname))

var featuresStr []string
for _, feature := range features.KnownFeatures {
Expand All @@ -350,7 +358,7 @@ func connectAction(ctx *cli.Context) error {
}
}
featuresStr = append(featuresStr, "["+ui.Icons.Ok+"]"+feature.ID)
slog.Debug(fmt.Sprintf("Feature '%s' marked enabled", feature.ID))
slog.Debug(localization.TF("Feature '%s' marked enabled", feature.ID))
} else {
if ui.IsOutputMachineReadable() {
switch feature.ID {
Expand All @@ -363,11 +371,11 @@ func connectAction(ctx *cli.Context) error {
}
}
featuresStr = append(featuresStr, "[ ]"+feature.ID)
slog.Debug(fmt.Sprintf("Feature '%s' marked disabled", feature.ID))
slog.Debug(localization.TF("Feature '%s' marked disabled", feature.ID))
}
}
featuresListStr := strings.Join(featuresStr, ", ")
ui.Printf("Features preferences: %s\n\n", featuresListStr)
ui.Printf("%s", localization.TF("Features preferences: %s\n\n", featuresListStr))

var start time.Time
durations := make(map[string]time.Duration)
Expand All @@ -388,12 +396,12 @@ func connectAction(ctx *cli.Context) error {
durations["yggdrasil"] = time.Since(start)

if connectResult.RHSMConnected {
ui.Printf("\nSuccessfully connected to Red Hat!\n")
ui.Printf("%s", localization.T("\nSuccessfully connected to Red Hat!\n"))
}

if !ui.IsOutputMachineReadable() {
/* 5. Show footer message */
fmt.Printf("\nManage your connected systems: https://red.ht/connector\n")
fmt.Print(localization.T("\nManage your connected systems: https://red.ht/connector\n"))

/* 6. Optionally display duration time of each sub-action */
showTimeDuration(durations)
Expand Down
Loading
Loading