fission-src/pkg/healthcheck/healthcheck.go

/*
Copyright 2022 The Fission Authors.
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,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package healthcheck

import (
	"context"
	"fmt"
	"strconv"
	"strings"

	"github.com/fatih/color"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/client-go/kubernetes"

	fv1 "github.com/fission/fission/pkg/apis/core/v1"
	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
	"github.com/fission/fission/pkg/fission-cli/cmd"
	"github.com/fission/fission/pkg/fission-cli/util"
)

type CategoryID string

const (
	Kubernetes      CategoryID = "kubernetes"
	FissionServices CategoryID = "fission-services"
	FissionVersion  CategoryID = "fission-version"
)

var (
	okStatus   = color.New(color.FgGreen, color.Bold).SprintFunc()("\u221A") // √
	failStatus = color.New(color.FgRed, color.Bold).SprintFunc()("\u00D7")   // ×
)

// Category is a group of checkers
type Category struct {
	ID       CategoryID
	checkers []Checker
	enabled  bool
}

type Checker struct {
	successMsg string
	check      func(ctx context.Context, input cli.Input, client cmd.Client) error
}

type HealthChecker struct {
	categories       []*Category
	kubeAPI          kubernetes.Interface
	fissionNamespace string
}

func isCompatibleVersion(minimalRequirementVersion [3]int, actualVersion [3]int) bool {
	if minimalRequirementVersion[0] < actualVersion[0] {
		return true
	}

	if (minimalRequirementVersion[0] == actualVersion[0]) && minimalRequirementVersion[1] < actualVersion[1] {
		return true
	}

	if (minimalRequirementVersion[0] == actualVersion[0]) && (minimalRequirementVersion[1] == actualVersion[1]) && (minimalRequirementVersion[2] <= actualVersion[2]) {
		return true
	}

	return false
}

func (hc *HealthChecker) CheckKubeVersion() (err error) {

	version, err := hc.kubeAPI.Discovery().ServerVersion()
	if err != nil {
		return err
	}

	major, _ := strconv.Atoi(version.Major)
	minor, _ := strconv.Atoi(version.Minor)
	apiVersion := [3]int{major, minor, 0}

	if !isCompatibleVersion(fv1.MinimumKubernetesVersion, apiVersion) {
		return fmt.Errorf("kubernetes is on version %d.%d.%d, but version %d.%d.%d or more recent is required",
			apiVersion[0], apiVersion[1], apiVersion[2],
			fv1.MinimumKubernetesVersion[0], fv1.MinimumKubernetesVersion[1], fv1.MinimumKubernetesVersion[2])
	}

	return nil
}

func (hc *HealthChecker) CheckServiceStatus(ctx context.Context, namespace string, name string) (err error) {
	depl, err := hc.kubeAPI.AppsV1().Deployments(namespace).Get(ctx, name, metav1.GetOptions{})
	if err != nil {
		return fmt.Errorf("failed to get %s deployment status", name)
	}

	if depl.Status.UnavailableReplicas > 0 || depl.Status.Replicas == 0 {
		return fmt.Errorf("%s deployment is not running", name)
	}

	_, err = hc.kubeAPI.CoreV1().Services(namespace).Get(ctx, name, metav1.GetOptions{})
	if err != nil {
		return fmt.Errorf("failed to get %s service status", name)
	}

	return nil
}

func (hc *HealthChecker) CheckFissionVersion(ctx context.Context, input cli.Input, client cmd.Client) error {
	ver := util.GetVersion(ctx, input, client)

	clientVersion := ver.Client["fission/core"].Version
	serverVersion := ver.Server["fission/core"].Version

	if clientVersion != serverVersion {
		return fmt.Errorf("client version %s does not match with server version %s", clientVersion, serverVersion)
	}

	return nil
}

func NewCategory(id CategoryID, checkers []Checker, enabled bool) *Category {
	return &Category{
		ID:       id,
		checkers: checkers,
		enabled:  enabled,
	}
}

func (hc *HealthChecker) allCategories() []*Category {
	return []*Category{
		NewCategory(
			Kubernetes,
			[]Checker{
				{
					successMsg: "kubernetes version is compatible",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) (err error) {
						return hc.CheckKubeVersion()
					},
				},
			},
			false,
		),
		NewCategory(
			FissionServices,
			[]Checker{
				{
					successMsg: "controller is running fine",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) error {
						return hc.CheckServiceStatus(ctx, hc.fissionNamespace, "controller")
					},
				},
				{
					successMsg: "executor is running fine",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) error {
						return hc.CheckServiceStatus(ctx, hc.fissionNamespace, "executor")
					},
				},
				{
					successMsg: "router is running fine",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) error {
						return hc.CheckServiceStatus(ctx, hc.fissionNamespace, "router")
					},
				},
				{
					successMsg: "storagesvc is running fine",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) error {
						return hc.CheckServiceStatus(ctx, hc.fissionNamespace, "storagesvc")
					},
				},
			},
			false,
		),
		NewCategory(
			FissionVersion,
			[]Checker{
				{
					successMsg: "fission is up-to-date",
					check: func(ctx context.Context, input cli.Input, client cmd.Client) error {
						return hc.CheckFissionVersion(ctx, input, client)
					},
				},
			},
			false,
		),
	}
}

func NewHealthChecker(cmd cmd.Client, categoryIDs []CategoryID) *HealthChecker {
	hc := &HealthChecker{
		kubeAPI:          cmd.KubernetesClient,
		fissionNamespace: "fission",
	}

	hc.categories = hc.allCategories()

	checkMap := map[CategoryID]struct{}{}
	for _, category := range categoryIDs {
		checkMap[category] = struct{}{}
	}
	for i := range hc.categories {
		if _, ok := checkMap[hc.categories[i].ID]; ok {
			hc.categories[i].enabled = true
		}
	}

	return hc
}

func RunChecks(ctx context.Context, input cli.Input, client cmd.Client, hc *HealthChecker) {
	for _, c := range hc.categories {
		if c.enabled {
			fmt.Println(c.ID)
			fmt.Println(strings.Repeat("-", 20))
			for _, checker := range c.checkers {
				err := checker.check(ctx, input, client)
				if err != nil {
					fmt.Printf("%s %s\n", failStatus, err)
				} else {
					fmt.Printf("%s %s\n", okStatus, checker.successMsg)
				}
			}
			fmt.Printf("\n")
		}
	}
}