featurebase/ctl/rbf_check.go
Lory Cloutier b6ae088f24 FB-1766: cleaning up the CmdIO objects passing alternate stdin/
stdout/stderr around

A lot of functions in the cmd and ctl packages were passing these
around and barely using them. Replaced them with a logger for most
functions. Some functions get an io.Writer instead so that their
tests can find the output they're looking for.

More cleanup on fb-1766: reworked the tests that were using io.Pipe
or os.Pipe to check their results so they now use a bytes.Buffer.

Unexported some variables that didn't need to be exported.
Fixed NewConfigCommand to use the provided stderr, not os.Stderr.
Added tests for rbf_dump, rbf_page, and keygen, since those weren't
being tested at all.

Added chksum_test, final cleanup.

(cherry picked from commit f627199acb)
2022-12-12 09:01:20 -08:00

59 lines
1.2 KiB
Go

// Copyright 2022 Molecula Corp. (DBA FeatureBase).
// SPDX-License-Identifier: Apache-2.0
package ctl
import (
"context"
"fmt"
"io"
"os"
"github.com/molecula/featurebase/v3/logger"
"github.com/molecula/featurebase/v3/rbf"
)
// RBFCheckCommand represents a command for running a consistency check on RBF.
type RBFCheckCommand struct {
// Filepath to the RBF database.
Path string
// Standard input/output
stdout io.Writer
logDest logger.Logger
}
// NewRBFCheckCommand returns a new instance of RBFCheckCommand.
func NewRBFCheckCommand(logdest logger.Logger) *RBFCheckCommand {
return &RBFCheckCommand{
stdout: os.Stdout,
logDest: logdest,
}
}
// Run executes a consistency check of an RBF database.
func (cmd *RBFCheckCommand) Run(ctx context.Context) error {
// Open database.
db := rbf.NewDB(cmd.Path, nil)
if err := db.Open(); err != nil {
return err
}
defer db.Close()
// Run check on the database.
if err := db.Check(); err != nil {
switch err := err.(type) {
case rbf.ErrorList:
for i := range err {
fmt.Fprintln(cmd.stdout, err[i])
}
default:
fmt.Fprintln(cmd.stdout, err)
}
return fmt.Errorf("check failed")
}
// If successful, print a success message.
fmt.Fprintln(cmd.stdout, "ok")
return nil
}