🐛 Ensure settings are redacted.

[jortel]

fixes #923

Summary by CodeRabbit

• New Features

  • Startup now logs the full application configuration in YAML with sensitive passphrases redacted, improving diagnostics and visibility.

• Style

  • Reformatted the startup log into a single multi-line message for clearer, more readable output on launch.

[coderabbitai]

Walkthrough

Startup logging now calls Settings.String() to produce a YAML-formatted, multi-line message. A new String() method on TackleSettings returns a YAML representation with Encryption.Passphrase redacted; it panics if YAML marshaling fails.

Changes

Cohort / File(s)	Summary of changes
Startup logging cmd/main.go	Replaced log.Info("Started", "settings", Settings) with log.Info("Started:\n" + Settings.String()) to log a single multi-line string.
Settings redaction utility settings/all.go	Added import for gopkg.in/yaml.v2 and a new method func (r TackleSettings) String() (s string) that copies the struct, redacts Encryption.Passphrase to "********", marshals the copy to YAML, panics on marshal error, and returns the YAML string.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Main as main()
  participant S as TackleSettings.String()
  participant Y as yaml.Marshal
  participant L as Logger

  Main->>S: call String()
  activate S
  note right of S: copy settings\nset Encryption.Passphrase = "********"
  S->>Y: Marshal(copy)
  Y-->>S: YAML string or error
  alt marshal success
    S-->>Main: YAML string
  else marshal error
    S-->>Main: panic
  end
  deactivate S
  Main->>L: Info("Started:\n" + YAML)
  L-->>Main: logged

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I thump the logs with gentle care,
Secrets swaddled, hidden fair.
YAML hums in tidy rows,
Passphrases masked where nobody knows.
I hop away — the startup glows. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly captures the main change of ensuring that logged settings are redacted and directly corresponds to the added redaction logic and updated startup logging in the changeset.
Linked Issues Check	✅ Passed	The changes introduce a String method that redacts sensitive fields on TackleSettings and update the startup log to use this method, fully satisfying the requirement from issue #923 to redact sensitive settings in logs.
Out of Scope Changes Check	✅ Passed	All modifications are focused on implementing the redaction logic and updating the startup log to use the redacted String output; no unrelated or extraneous changes are present.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be96181 and 8450ecf.

📒 Files selected for processing (1)

• settings/all.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• settings/all.go

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84cd59e and 0037a7f.

📒 Files selected for processing (2)

• assessment/membership.go (1 hunks)
• settings/all.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• settings/all.go

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: test-unit
• GitHub Check: vet
• GitHub Check: build

[jortel]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[jortel]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[jortel]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7db576 and f23580e.

📒 Files selected for processing (2)

• cmd/main.go (1 hunks)
• settings/all.go (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-04T21:52:20.577Z

Learnt from: jortel
PR: konveyor/tackle2-hub#897
File: cmd/main.go:131-131
Timestamp: 2025-09-04T21:52:20.577Z
Learning: In the tackle2-hub project, the Settings struct in cmd/main.go does not contain secrets and all fields are useful for diagnostic logging during startup.

Applied to files:

• cmd/main.go