github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/dm/pkg/checker/real_checker.go

// Copyright 2021 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.

package checker

import (
	"context"
	"fmt"
	"sync"
)

// RealChecker is interface that defines RealChecker to check configurations of system.
// It is mainly used for configuration checking of data synchronization between database systems.
type RealChecker interface {
	Name() string
	Check(ctx context.Context) *Result
}

// State is state of check.
type State string

const (
	// StateSuccess indicates that the check was successful.
	StateSuccess State = "success"
	// StateFailure indicates that the check was failed.
	StateFailure State = "fail"
	// StateWarning indicates that the check had warnings.
	StateWarning State = "warn"
)

type Error struct {
	Severity    State  `json:"severity"`
	ShortErr    string `json:"short_error"`
	Self        string `json:"self,omitempty"`
	Other       string `json:"other,omitempty"`
	Instruction string `json:"instruction,omitempty"`
}

// NewError creates a pointer to Error, the parameters could be used as in Sprintf.
func NewError(description string, args ...interface{}) *Error {
	return &Error{Severity: StateFailure, ShortErr: fmt.Sprintf(description, args...)}
}

// NewWarn creates a pointer to Error, the parameters could be used as in Sprintf.
func NewWarn(description string, args ...interface{}) *Error {
	return &Error{Severity: StateWarning, ShortErr: fmt.Sprintf(description, args...)}
}

// Result is result of check.
type Result struct {
	ID          uint64   `json:"id"`
	Name        string   `json:"name"`
	Desc        string   `json:"desc"`
	State       State    `json:"state"`
	Errors      []*Error `json:"errors,omitempty"`
	Instruction string   `json:"instruction,omitempty"`
	Extra       string   `json:"extra,omitempty"`
}

// ResultSummary is summary of all check results.
type ResultSummary struct {
	Passed     bool  `json:"passed"`
	Total      int64 `json:"total"`
	Successful int64 `json:"successful"`
	Failed     int64 `json:"failed"`
	Warning    int64 `json:"warning"`
}

// Results contains all check results and summary.
type Results struct {
	Results []*Result      `json:"results"`
	Summary *ResultSummary `json:"summary"`
}

// Do executes several RealCheckers.
func Do(ctx context.Context, checkers []RealChecker) (*Results, error) {
	results := &Results{
		Results: make([]*Result, 0, len(checkers)),
	}
	if len(checkers) == 0 {
		results.Summary = &ResultSummary{Passed: true}
		return results, nil
	}

	var (
		wg         sync.WaitGroup
		finished   bool
		total      int64
		successful int64
		failed     int64
		warning    int64
	)
	total = int64(len(checkers))

	resultCh := make(chan *Result)

	wg.Add(1)
	go func() {
		defer wg.Done()
		for {
			result := <-resultCh
			switch result.State {
			case StateSuccess:
				successful++
			case StateFailure:
				failed++
			case StateWarning:
				warning++
			}

			// if total == successful + warning + failed, it's finished
			finished = total == successful+warning+failed
			results.Results = append(results.Results, result)

			if finished {
				return
			}
		}
	}()

	for i, checker := range checkers {
		wg.Add(1)
		go func(i int, checker RealChecker) {
			defer wg.Done()
			result := checker.Check(ctx)
			result.ID = uint64(i)
			resultCh <- result
		}(i, checker)
	}
	wg.Wait()

	passed := finished && (failed == 0)
	results.Summary = &ResultSummary{
		Passed:     passed,
		Total:      total,
		Successful: successful,
		Failed:     failed,
		Warning:    warning,
	}

	return results, nil
}