From 96bb79a6600ea57057109a9d1db3374a129dea21 Mon Sep 17 00:00:00 2001 From: Ross Fairbanks Date: Mon, 4 Jan 2021 11:59:32 +0100 Subject: [PATCH] Use latest micrologger (#79) * Use latest micrologger * Add fix for micrologger * Use micrologger v0.5.0 --- cmd/bootstrap/runner.go | 56 ++++++++++---------- go.mod | 2 +- go.sum | 2 + integration/test/bootstrap/bootstrap_test.go | 7 ++- 4 files changed, 34 insertions(+), 33 deletions(-) diff --git a/cmd/bootstrap/runner.go b/cmd/bootstrap/runner.go index e2e5d0a..37b6c98 100644 --- a/cmd/bootstrap/runner.go +++ b/cmd/bootstrap/runner.go @@ -221,14 +221,14 @@ func (r *runner) ensureCRDs(ctx context.Context, k8sClients k8sclient.Interface) { for _, crdName := range crds { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensuring %#q CRD", crdName)) + r.logger.Debugf(ctx, "ensuring %#q CRD", crdName) err := k8sClients.CRDClient().EnsureCreated(ctx, crd.LoadV1("application.giantswarm.io", crdName), backoff.NewMaxRetries(7, 1*time.Second)) if err != nil { return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensured %#q CRD exists", crdName)) + r.logger.Debugf(ctx, "ensured %#q CRD exists", crdName) } } @@ -238,7 +238,7 @@ func (r *runner) ensureCRDs(ctx context.Context, k8sClients k8sclient.Interface) func (r *runner) ensureNamespace(ctx context.Context, k8sClients k8sclient.Interface) error { namespace := "giantswarm" - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensuring namespace %#q", namespace)) + r.logger.Debugf(ctx, "ensuring namespace %#q", namespace) o := func() error { { @@ -249,7 +249,7 @@ func (r *runner) ensureNamespace(ctx context.Context, k8sClients k8sclient.Inter } _, err := k8sClients.K8sClient().CoreV1().Namespaces().Create(ctx, n, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("namespace %#q already exists", namespace)) + r.logger.Debugf(ctx, "namespace %#q already exists", namespace) // fall through } else if err != nil { return microerror.Mask(err) @@ -275,7 +275,7 @@ func (r *runner) ensureNamespace(ctx context.Context, k8sClients k8sclient.Inter return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensured namespace %#q", namespace)) + r.logger.Debugf(ctx, "ensured namespace %#q", namespace) return nil } @@ -283,7 +283,7 @@ func (r *runner) ensureNamespace(ctx context.Context, k8sClients k8sclient.Inter func (r *runner) ensurePriorityClass(ctx context.Context, k8sClients k8sclient.Interface) error { priorityClassName := "giantswarm-critical" - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("creating priorityclass %#q", priorityClassName)) + r.logger.Debugf(ctx, "creating priorityclass %#q", priorityClassName) pc := &schedulingv1.PriorityClass{ ObjectMeta: metav1.ObjectMeta{ @@ -296,12 +296,12 @@ func (r *runner) ensurePriorityClass(ctx context.Context, k8sClients k8sclient.I _, err := k8sClients.K8sClient().SchedulingV1().PriorityClasses().Create(ctx, pc, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("priorityclass %#q already exists", priorityClassName)) + r.logger.Debugf(ctx, "priorityclass %#q already exists", priorityClassName) // fall through } else if err != nil { return microerror.Mask(err) } else { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("created priorityclass %#q", priorityClassName)) + r.logger.Debugf(ctx, "created priorityclass %#q", priorityClassName) } return nil @@ -315,7 +315,7 @@ func (r *runner) installAppCatalogs(ctx context.Context, k8sClients k8sclient.In } for name, url := range catalogs { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("creating %#q appcatalog cr", name)) + r.logger.Debugf(ctx, "creating %#q appcatalog cr", name) appCatalogCR := &v1alpha1.AppCatalog{ ObjectMeta: metav1.ObjectMeta{ @@ -336,12 +336,12 @@ func (r *runner) installAppCatalogs(ctx context.Context, k8sClients k8sclient.In } _, err = k8sClients.G8sClient().ApplicationV1alpha1().AppCatalogs().Create(ctx, appCatalogCR, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("%#q appcatalog CR already exists", appCatalogCR.Name)) + r.logger.Debugf(ctx, "%#q appcatalog CR already exists", appCatalogCR.Name) } else if err != nil { return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("created %#q appcatalog cr", name)) + r.logger.Debugf(ctx, "created %#q appcatalog cr", name) } return nil @@ -349,7 +349,7 @@ func (r *runner) installAppCatalogs(ctx context.Context, k8sClients k8sclient.In func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient.Interface) error { name := "chartmuseum-psp" - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensuring psp %#q", name)) + r.logger.Debugf(ctx, "ensuring psp %#q", name) o := func() error { { @@ -368,7 +368,7 @@ func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient. } _, err := k8sClients.K8sClient().RbacV1().ClusterRoles().Create(ctx, clusterRole, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("clusterRole %#q already exists", name)) + r.logger.Debugf(ctx, "clusterRole %#q already exists", name) // fall through } else if err != nil { return microerror.Mask(err) @@ -394,7 +394,7 @@ func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient. } _, err := k8sClients.K8sClient().RbacV1().ClusterRoleBindings().Create(ctx, clusterRoleBinding, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("clusterRoleBinding %#q already exists", name)) + r.logger.Debugf(ctx, "clusterRoleBinding %#q already exists", name) // fall through } else if err != nil { return microerror.Mask(err) @@ -426,7 +426,7 @@ func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient. } _, err := k8sClients.K8sClient().PolicyV1beta1().PodSecurityPolicies().Create(ctx, psp, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("psp %#q already exists", name)) + r.logger.Debugf(ctx, "psp %#q already exists", name) // fall through } else if err != nil { return microerror.Mask(err) @@ -468,7 +468,7 @@ func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient. } _, err := k8sClients.K8sClient().NetworkingV1().NetworkPolicies(namespace).Create(ctx, np, metav1.CreateOptions{}) if apierrors.IsAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("networkpolicy %#q already exists", name)) + r.logger.Debugf(ctx, "networkpolicy %#q already exists", name) // fall through } else if err != nil { return microerror.Mask(err) @@ -484,7 +484,7 @@ func (r *runner) ensureChartMuseumPSP(ctx context.Context, k8sClients k8sclient. return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensured psp %#q", name)) + r.logger.Debugf(ctx, "ensured psp %#q", name) return nil } @@ -493,7 +493,7 @@ func (r *runner) installChartMuseum(ctx context.Context, appTest apptest.Interfa var err error { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("creating %#q app cr", chartMuseumName)) + r.logger.Debugf(ctx, "creating %#q app cr", chartMuseumName) apps := []apptest.App{ { @@ -511,7 +511,7 @@ func (r *runner) installChartMuseum(ctx context.Context, appTest apptest.Interfa return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("created %#q app cr", chartMuseumName)) + r.logger.Debugf(ctx, "created %#q app cr", chartMuseumName) } return nil @@ -539,23 +539,23 @@ func (r *runner) installOperators(ctx context.Context, helmClient helmclient.Int func (r *runner) installOperator(ctx context.Context, helmClient helmclient.Interface, name, version string) error { var operatorTarballPath string { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("getting tarball URL for %#q", name)) + r.logger.Debugf(ctx, "getting tarball URL for %#q", name) operatorTarballURL, err := appcatalog.GetLatestChart(ctx, controlPlaneCatalogStorageURL, name, version) if err != nil { return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("tarball URL is %#q", operatorTarballURL)) + r.logger.Debugf(ctx, "tarball URL is %#q", operatorTarballURL) - r.logger.LogCtx(ctx, "level", "debug", "message", "pulling tarball") + r.logger.Debugf(ctx, "pulling tarball") operatorTarballPath, err = helmClient.PullChartTarball(ctx, operatorTarballURL) if err != nil { return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("tarball path is %#q", operatorTarballPath)) + r.logger.Debugf(ctx, "tarball path is %#q", operatorTarballPath) } { @@ -563,11 +563,11 @@ func (r *runner) installOperator(ctx context.Context, helmClient helmclient.Inte fs := afero.NewOsFs() err := fs.Remove(operatorTarballPath) if err != nil { - r.logger.LogCtx(ctx, "level", "error", "message", fmt.Sprintf("deletion of %#q failed", operatorTarballPath), "stack", fmt.Sprintf("%#v", err)) + r.logger.Errorf(ctx, err, "deletion of %#q failed", operatorTarballPath) } }() - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("installing %#q", name)) + r.logger.Debugf(ctx, "installing %#q", name) // Set control plane operator values so chart-operator DNS settings are // correct. @@ -591,16 +591,16 @@ func (r *runner) installOperator(ctx context.Context, helmClient helmclient.Inte input, opts) if helmclient.IsCannotReuseRelease(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("%#q already installed", name)) + r.logger.Debugf(ctx, "%#q already installed", name) return nil } else if helmclient.IsReleaseAlreadyExists(err) { - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("%#q already installed", name)) + r.logger.Debugf(ctx, "%#q already installed", name) return nil } else if err != nil { return microerror.Mask(err) } - r.logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("installed %#q", name)) + r.logger.Debugf(ctx, "installed %#q", name) } return nil diff --git a/go.mod b/go.mod index 827ff49..9976be7 100644 --- a/go.mod +++ b/go.mod @@ -10,7 +10,7 @@ require ( github.com/giantswarm/helmclient/v4 v4.1.0 github.com/giantswarm/k8sclient/v5 v5.0.0 github.com/giantswarm/microerror v0.3.0 - github.com/giantswarm/micrologger v0.4.0 + github.com/giantswarm/micrologger v0.5.0 github.com/giantswarm/to v0.3.0 github.com/spf13/afero v1.5.1 github.com/spf13/cobra v1.1.1 diff --git a/go.sum b/go.sum index 84a8732..439474a 100644 --- a/go.sum +++ b/go.sum @@ -261,6 +261,8 @@ github.com/giantswarm/micrologger v0.3.1/go.mod h1:PjAgtcJ922ZMX/Aa05IPi0bdYvOj2 github.com/giantswarm/micrologger v0.3.3/go.mod h1:fkzQdDBC6HjJq4nllBDt6XB4t4yeVyhdHKblFX6QoMQ= github.com/giantswarm/micrologger v0.4.0 h1:2EpnX86HKpqUNY8C4qbB2SzniB4bgES8Cd/mYrVyOrI= github.com/giantswarm/micrologger v0.4.0/go.mod h1:xsD5laBXORMy/P34IHZMK0y/D1gTkYtASUL4gUm5KN4= +github.com/giantswarm/micrologger v0.5.0 h1:/f2knkyf4bZw3L5F48R7VENiEKPb3Sjnzrg46+Ja5vk= +github.com/giantswarm/micrologger v0.5.0/go.mod h1:J/jbt7A8eixqE40yq4JY8Hdbs/qeboe2FjHlq05UWjA= github.com/giantswarm/to v0.3.0 h1:cEzMYkWLGI3cI8x3a0L3nPCQYJTb/cAaqcIPvxnDmpQ= github.com/giantswarm/to v0.3.0/go.mod h1:RTRtw+Dyk6YqoiNBOGLO981BqhibtVwogdaFIMO1y/A= github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q= diff --git a/integration/test/bootstrap/bootstrap_test.go b/integration/test/bootstrap/bootstrap_test.go index d328e8e..7764c25 100644 --- a/integration/test/bootstrap/bootstrap_test.go +++ b/integration/test/bootstrap/bootstrap_test.go @@ -4,7 +4,6 @@ package bootstrap import ( "context" - "fmt" "testing" "time" @@ -23,7 +22,7 @@ func TestBootstrap(t *testing.T) { ctx := context.Background() { - config.Logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensuring %#q app CR is deployed", key.ChartMuseumAppName())) + config.Logger.Debugf(ctx, "ensuring %#q app CR is deployed", key.ChartMuseumAppName()) o := func() error { app, err := config.K8sClients.G8sClient().ApplicationV1alpha1().Apps(key.Namespace()).Get(ctx, key.ChartMuseumAppName(), metav1.GetOptions{}) @@ -37,7 +36,7 @@ func TestBootstrap(t *testing.T) { } n := func(err error, t time.Duration) { - config.Logger.Log("level", "debug", "message", fmt.Sprintf("failed to get app CR status '%s': retrying in %s", helmclient.StatusDeployed, t), "stack", fmt.Sprintf("%v", err)) + config.Logger.Errorf(ctx, err, "failed to get app CR status '%s': retrying in %s", helmclient.StatusDeployed, t) } b := backoff.NewConstant(20*time.Minute, 60*time.Second) @@ -46,6 +45,6 @@ func TestBootstrap(t *testing.T) { t.Fatalf("expected %#v got %#v", nil, err) } - config.Logger.LogCtx(ctx, "level", "debug", "message", fmt.Sprintf("ensured %#q app CR is deployed", key.ChartMuseumAppName())) + config.Logger.Debugf(ctx, "ensured %#q app CR is deployed", key.ChartMuseumAppName()) } }