rkt/rkt

Wrap logging + os.Exit calls in a package

Open

#2452 opened on Apr 19, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (8,871 stars) (865 forks)batch import
area/developer toolinghelp wantedlow hanging fruittechnology/go

Description

There are lots of os.Exit invocations and logging calls before them throughout the code.

We can improve the readability by creating a new exit package that also supports formatting by using something like this:

  • exit.Success("operation successful %q", output) or exit.OK("operation successful")
  • exit.Error("cannot do something")

After that we can intercept the invocations for testing purposes as well.

Contributor guide

Tech stack
go
Domain
backendtestingdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingrkt project structureLogging patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
First, grep for all os.Exit and logging calls in the codebase to understand current usage. Then design an exit package with functions like Success and Error that combine logging and exit. Replace all direct os.Exit calls with the new package. Add unit tests for the exit package to ensure correctness and testability.