github.com/verrazzano/verrazzano@v1.7.0/tools/vz/pkg/analysis/internal/util/cluster/rancher/catalogs.go (about)

     1  // Copyright (c) 2023, Oracle and/or its affiliates.
     2  // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
     3  
     4  package rancher
     5  
     6  import (
     7  	"fmt"
     8  	"path/filepath"
     9  
    10  	"github.com/verrazzano/verrazzano/tools/vz/pkg/analysis/internal/util/files"
    11  	"github.com/verrazzano/verrazzano/tools/vz/pkg/analysis/internal/util/report"
    12  	corev1 "k8s.io/api/core/v1"
    13  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    14  )
    15  
    16  const catalogResource = "catalog.management.cattle.io"
    17  
    18  // Minimal definition of object that only contains the fields that will be analyzed
    19  type catalogsList struct {
    20  	metav1.TypeMeta `json:",inline"`
    21  	metav1.ListMeta `json:"metadata,omitempty"`
    22  	Items           []catalog `json:"items"`
    23  }
    24  type catalog struct {
    25  	metav1.TypeMeta   `json:",inline"`
    26  	metav1.ObjectMeta `json:"metadata,omitempty"`
    27  	Spec              catalogSpec  `json:"spec,omitempty"`
    28  	Status            cattleStatus `json:"status,omitempty"`
    29  }
    30  type catalogSpec struct {
    31  	Branch string `json:"branch,omitempty"`
    32  	URL    string `json:"url,omitempty"`
    33  }
    34  
    35  // AnalyzeCatalogs - analyze the status of Catalog objects
    36  func AnalyzeCatalogs(clusterRoot string, namespace string, issueReporter *report.IssueReporter) error {
    37  	resourceRoot := clusterRoot
    38  	if len(namespace) != 0 {
    39  		resourceRoot = filepath.Join(clusterRoot, namespace)
    40  	}
    41  
    42  	list := &catalogsList{}
    43  	err := files.UnmarshallFileInClusterRoot(resourceRoot, fmt.Sprintf("%s.json", catalogResource), list)
    44  	if err != nil {
    45  		return err
    46  	}
    47  
    48  	for _, catalog := range list.Items {
    49  		err = analyzeCatalog(clusterRoot, catalog, issueReporter)
    50  		if err != nil {
    51  			return err
    52  		}
    53  	}
    54  
    55  	return nil
    56  }
    57  
    58  // analyzeCatalog - analyze a single Catalog and report any issues
    59  func analyzeCatalog(clusterRoot string, catalog catalog, issueReporter *report.IssueReporter) error {
    60  
    61  	var messages []string
    62  	var subMessage string
    63  	for _, condition := range catalog.Status.Conditions {
    64  		if condition.Status != corev1.ConditionTrue {
    65  			switch condition.Type {
    66  			case "SecretsMigrated":
    67  				subMessage = "secrets not migrated"
    68  			case "Refreshed":
    69  				subMessage = "not refreshed"
    70  			default:
    71  				continue
    72  			}
    73  			// Add a message for the issue
    74  			reason := ""
    75  			msg := ""
    76  			if len(condition.Reason) > 0 {
    77  				reason = fmt.Sprintf(", reason is %q", condition.Reason)
    78  			}
    79  			if len(condition.Message) > 0 {
    80  				msg = fmt.Sprintf(", message is %q", condition.Message)
    81  			}
    82  			message := fmt.Sprintf("\t%s %s%s", subMessage, reason, msg)
    83  			messages = append([]string{message}, messages...)
    84  		}
    85  	}
    86  
    87  	if len(messages) > 0 {
    88  		messages = append([]string{fmt.Sprintf("Rancher %s resource %q on branch %s with URL %s", catalogResource, catalog.Name, catalog.Spec.Branch, catalog.Spec.URL)}, messages...)
    89  		issueReporter.AddKnownIssueMessagesFiles(report.RancherIssues, clusterRoot, messages, []string{})
    90  	}
    91  
    92  	return nil
    93  }