Skip to content

Commit 9e5ae1c

Browse files
committed
*: use logrus instead of std log
1 parent 48d8946 commit 9e5ae1c

File tree

18 files changed

+96
-88
lines changed

18 files changed

+96
-88
lines changed

commands/operator-sdk/cmd/add/api.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,12 @@
1515
package add
1616

1717
import (
18-
"log"
19-
2018
"github.com/operator-framework/operator-sdk/commands/operator-sdk/cmd/generate"
2119
"github.com/operator-framework/operator-sdk/internal/util/projutil"
2220
"github.com/operator-framework/operator-sdk/pkg/scaffold"
2321
"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
2422

23+
log "github.com/sirupsen/logrus"
2524
"github.com/spf13/cobra"
2625
)
2726

@@ -95,7 +94,7 @@ func apiRun(cmd *cobra.Command, args []string) {
9594

9695
// update deploy/role.yaml for the given resource r.
9796
if err := scaffold.UpdateRoleForResource(r, absProjectPath); err != nil {
98-
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): %v", r.APIVersion, r.Kind, err)
97+
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): (%v)", r.APIVersion, r.Kind, err)
9998
}
10099

101100
// Run k8s codegen for deepcopy

commands/operator-sdk/cmd/add/controller.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@
1515
package add
1616

1717
import (
18-
"log"
19-
2018
"github.com/operator-framework/operator-sdk/internal/util/projutil"
2119
"github.com/operator-framework/operator-sdk/pkg/scaffold"
2220
"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
2321

22+
log "github.com/sirupsen/logrus"
2423
"github.com/spf13/cobra"
2524
)
2625

commands/operator-sdk/cmd/add/crd.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ package add
1616

1717
import (
1818
"fmt"
19-
"log"
2019
"os"
2120
"path/filepath"
2221
"strings"
@@ -25,6 +24,7 @@ import (
2524
"github.com/operator-framework/operator-sdk/pkg/scaffold"
2625
"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
2726

27+
log "github.com/sirupsen/logrus"
2828
"github.com/spf13/cobra"
2929
)
3030

@@ -60,26 +60,26 @@ func crdFunc(cmd *cobra.Command, args []string) {
6060
verifyCrdFlags()
6161
verifyCrdDeployPath()
6262

63-
fmt.Fprintln(os.Stdout, "Generating custom resource definition (CRD) file")
63+
fmt.Println("Generating custom resource definition (CRD) file")
6464

6565
// generate CR/CRD file
6666
resource, err := scaffold.NewResource(apiVersion, kind)
6767
if err != nil {
68-
log.Fatalf("%v", err)
68+
log.Fatal(err)
6969
}
70+
7071
s := scaffold.Scaffold{}
7172
err = s.Execute(cfg,
7273
&scaffold.Crd{Resource: resource},
7374
&scaffold.Cr{Resource: resource},
7475
)
75-
7676
if err != nil {
7777
log.Fatalf("add scaffold failed: (%v)", err)
7878
}
7979

8080
// update deploy/role.yaml for the given resource r.
8181
if err := scaffold.UpdateRoleForResource(resource, cfg.AbsProjectPath); err != nil {
82-
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): %v", resource.APIVersion, resource.Kind, err)
82+
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): (%v)", resource.APIVersion, resource.Kind, err)
8383
}
8484
}
8585

@@ -103,7 +103,7 @@ func verifyCrdFlags() {
103103
func verifyCrdDeployPath() {
104104
wd, err := os.Getwd()
105105
if err != nil {
106-
log.Fatalf("failed to determine the full path of the current directory: %v", err)
106+
log.Fatalf("failed to determine the full path of the current directory: (%v)", err)
107107
}
108108
// check if the deploy sub-directory exist
109109
_, err = os.Stat(filepath.Join(wd, scaffold.DeployDir))

commands/operator-sdk/cmd/build.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import (
1919
"errors"
2020
"fmt"
2121
"io/ioutil"
22-
"log"
2322
"os"
2423
"os/exec"
2524
"path/filepath"
@@ -30,6 +29,7 @@ import (
3029
"github.com/operator-framework/operator-sdk/pkg/test"
3130

3231
"github.com/ghodss/yaml"
32+
log "github.com/sirupsen/logrus"
3333
"github.com/spf13/cobra"
3434
)
3535

@@ -78,11 +78,11 @@ func verifyDeploymentImage(yamlFile []byte, imageName string) error {
7878
yamlMap := make(map[string]interface{})
7979
err := yaml.Unmarshal(yamlSpec, &yamlMap)
8080
if err != nil {
81-
log.Fatal("Could not unmarshal yaml namespaced spec")
81+
log.Fatalf("could not unmarshal yaml namespaced spec: (%v)", err)
8282
}
8383
kind, ok := yamlMap["kind"].(string)
8484
if !ok {
85-
log.Fatal("Yaml manifest file contains a 'kind' field that is not a string")
85+
log.Fatal("yaml manifest file contains a 'kind' field that is not a string")
8686
}
8787
if kind == "Deployment" {
8888
// this is ugly and hacky; we should probably make this cleaner
@@ -122,13 +122,13 @@ func verifyDeploymentImage(yamlFile []byte, imageName string) error {
122122
func verifyTestManifest(image string) {
123123
namespacedBytes, err := ioutil.ReadFile(namespacedManBuild)
124124
if err != nil {
125-
log.Fatalf("could not read namespaced manifest: %v", err)
125+
log.Fatalf("could not read namespaced manifest: (%v)", err)
126126
}
127127

128128
err = verifyDeploymentImage(namespacedBytes, image)
129129
// the error from verifyDeploymentImage is just a warning, not fatal error
130130
if err != nil {
131-
fmt.Printf("%v\n", err)
131+
log.Warn(err)
132132
}
133133
}
134134

@@ -141,7 +141,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
141141
goBuildEnv := append(os.Environ(), "GOOS=linux", "GOARCH=amd64", "CGO_ENABLED=0")
142142
wd, err := os.Getwd()
143143
if err != nil {
144-
log.Fatalf("could not identify current working directory: %v", err)
144+
log.Fatalf("could not identify current working directory: (%v)", err)
145145
}
146146

147147
// Don't need to build go code if Ansible Operator
@@ -154,7 +154,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
154154
buildCmd.Stderr = os.Stderr
155155
err = buildCmd.Run()
156156
if err != nil {
157-
log.Fatalf("failed to build operator binary: %v", err)
157+
log.Fatalf("failed to build operator binary: (%v)", err)
158158
}
159159
}
160160

@@ -169,9 +169,9 @@ func buildFunc(cmd *cobra.Command, args []string) {
169169
err = dbcmd.Run()
170170
if err != nil {
171171
if enableTests {
172-
log.Fatalf("failed to build intermediate image for %s image: %v", image, err)
172+
log.Fatalf("failed to output intermediate image %s: (%v)", image, err)
173173
} else {
174-
log.Fatalf("failed to output build image %s: %v", image, err)
174+
log.Fatalf("failed to output build image %s: (%v)", image, err)
175175
}
176176
}
177177

@@ -183,7 +183,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
183183
buildTestCmd.Stderr = os.Stderr
184184
err = buildTestCmd.Run()
185185
if err != nil {
186-
log.Fatalf("failed to build test binary: %v", err)
186+
log.Fatalf("failed to build test binary: (%v)", err)
187187
}
188188
// if a user is using an older sdk repo as their library, make sure they have required build files
189189
testDockerfile := filepath.Join(scaffold.BuildTestDir, scaffold.DockerfileFile)
@@ -204,7 +204,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
204204
&scaffold.TestPod{Image: image, TestNamespaceEnv: test.TestNamespaceEnv},
205205
)
206206
if err != nil {
207-
log.Fatalf("build scaffold failed: (%v)", err)
207+
log.Fatalf("test scaffold failed: (%v)", err)
208208
}
209209
}
210210

@@ -213,7 +213,7 @@ func buildFunc(cmd *cobra.Command, args []string) {
213213
testDbcmd.Stderr = os.Stderr
214214
err = testDbcmd.Run()
215215
if err != nil {
216-
log.Fatalf("failed to output build image %s: %v", image, err)
216+
log.Fatalf("failed to output test image %s: (%v)", image, err)
217217
}
218218
// Check image name of deployments in namespaced manifest
219219
verifyTestManifest(image)

commands/operator-sdk/cmd/generate/k8s.go

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ package generate
1717
import (
1818
"fmt"
1919
"io/ioutil"
20-
"log"
2120
"os"
2221
"os/exec"
2322
"path/filepath"
2423

2524
"github.com/operator-framework/operator-sdk/internal/util/projutil"
2625
"github.com/operator-framework/operator-sdk/pkg/scaffold"
2726

27+
log "github.com/sirupsen/logrus"
2828
"github.com/spf13/cobra"
2929
)
3030

@@ -41,7 +41,7 @@ to comply with kube-API requirements.
4141

4242
func k8sFunc(cmd *cobra.Command, args []string) {
4343
if len(args) != 0 {
44-
log.Fatalf("k8s command doesn't accept any arguments.")
44+
log.Fatal("k8s command doesn't accept any arguments")
4545
}
4646

4747
// Only Go projects can generate k8s deepcopy code.
@@ -62,7 +62,7 @@ func K8sCodegen() {
6262
log.Fatalf("failed to parse group versions: (%v)", err)
6363
}
6464

65-
fmt.Fprintf(os.Stdout, "Running code-generation for custom resource group versions: [%s]\n", groupVersions)
65+
log.Printf("Running code-generation for custom resource group versions: [%s]\n", groupVersions)
6666
// TODO: Replace generate-groups.sh by building the vendored generators(deepcopy, lister etc)
6767
// and running them directly
6868
// TODO: remove dependency on boilerplate.go.txt
@@ -73,11 +73,13 @@ func K8sCodegen() {
7373
apisPkg,
7474
groupVersions,
7575
}
76-
out, err := exec.Command(genGroupsCmd, args...).CombinedOutput()
76+
cgCmd := exec.Command(genGroupsCmd, args...)
77+
cgCmd.Stdout = os.Stdout
78+
cgCmd.Stderr = os.Stderr
79+
err = cgCmd.Run()
7780
if err != nil {
7881
log.Fatalf("failed to perform code-generation: (%v)", err)
7982
}
80-
fmt.Fprintln(os.Stdout, string(out))
8183
}
8284

8385
// getGroupVersions parses the layout of pkg/apis to return the API groups and versions
@@ -108,5 +110,9 @@ func parseGroupVersions() (string, error) {
108110
}
109111
}
110112

113+
if groupVersions == "" {
114+
return "", fmt.Errorf("no groups or versions found in %s", scaffold.ApisDir)
115+
}
116+
111117
return groupVersions, nil
112118
}

commands/operator-sdk/cmd/new.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ package cmd
1717
import (
1818
"fmt"
1919
"io/ioutil"
20-
"log"
2120
"os"
2221
"os/exec"
2322
"path/filepath"
@@ -28,6 +27,7 @@ import (
2827
"github.com/operator-framework/operator-sdk/pkg/scaffold/ansible"
2928
"github.com/operator-framework/operator-sdk/pkg/scaffold/input"
3029

30+
log "github.com/sirupsen/logrus"
3131
"github.com/spf13/cobra"
3232
)
3333

@@ -150,13 +150,13 @@ func doAnsibleScaffold() {
150150

151151
resource, err := scaffold.NewResource(apiVersion, kind)
152152
if err != nil {
153-
log.Fatal("Invalid apiVersion and kind.")
153+
log.Fatalf("invalid apiVersion and kind: (%v)", err)
154154
}
155155

156156
s := &scaffold.Scaffold{}
157157
tmpdir, err := ioutil.TempDir("", "osdk")
158158
if err != nil {
159-
log.Fatal("unable to get temp directory")
159+
log.Fatalf("unable to get temp directory: (%v)", err)
160160
}
161161

162162
galaxyInit := &ansible.GalaxyInit{
@@ -196,7 +196,7 @@ func doAnsibleScaffold() {
196196
},
197197
)
198198
if err != nil {
199-
log.Fatalf("new scaffold failed: (%v)", err)
199+
log.Fatalf("new playbook scaffold failed: (%v)", err)
200200
}
201201
}
202202

@@ -210,12 +210,12 @@ func doAnsibleScaffold() {
210210
// everything.
211211
tmpDirectorySlice := strings.Split(os.TempDir(), "/")
212212
if err = os.RemoveAll(filepath.Join(galaxyInit.AbsProjectPath, tmpDirectorySlice[1])); err != nil {
213-
log.Fatalf("failed to remove the galaxy init script")
213+
log.Fatalf("failed to remove the galaxy init script: (%v)", err)
214214
}
215215

216216
// update deploy/role.yaml for the given resource r.
217217
if err := scaffold.UpdateRoleForResource(resource, cfg.AbsProjectPath); err != nil {
218-
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): %v", resource.APIVersion, resource.Kind, err)
218+
log.Fatalf("failed to update the RBAC manifest for the resource (%v, %v): (%v)", resource.APIVersion, resource.Kind, err)
219219
}
220220
}
221221

@@ -254,14 +254,14 @@ func execCmd(stdout *os.File, cmd string, args ...string) {
254254
dc.Stderr = os.Stderr
255255
err := dc.Run()
256256
if err != nil {
257-
log.Fatalf("failed to exec %s %#v: %v", cmd, args, err)
257+
log.Fatalf("failed to exec %s %#v: (%v)", cmd, args, err)
258258
}
259259
}
260260

261261
func pullDep() {
262262
_, err := exec.LookPath(dep)
263263
if err != nil {
264-
log.Fatalf("looking for dep in $PATH: %v", err)
264+
log.Fatalf("looking for dep in $PATH: (%v)", err)
265265
}
266266
fmt.Fprintln(os.Stdout, "Run dep ensure ...")
267267
execCmd(os.Stdout, dep, ensureCmd, "-v")

commands/operator-sdk/cmd/test/cluster.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import (
2424
"github.com/operator-framework/operator-sdk/pkg/scaffold"
2525
"github.com/operator-framework/operator-sdk/pkg/test"
2626

27+
log "github.com/sirupsen/logrus"
2728
"github.com/spf13/cobra"
2829
v1 "k8s.io/api/core/v1"
2930
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -110,7 +111,7 @@ func testClusterFunc(cmd *cobra.Command, args []string) error {
110111
defer func() {
111112
err = kubeclient.CoreV1().Pods(tcConfig.namespace).Delete(testPod.Name, &metav1.DeleteOptions{})
112113
if err != nil {
113-
fmt.Printf("Warning: failed to delete test pod")
114+
log.Warn("failed to delete test pod")
114115
}
115116
}()
116117
err = wait.Poll(time.Second*5, time.Second*time.Duration(tcConfig.pendingTimeout), func() (bool, error) {
@@ -140,7 +141,7 @@ func testClusterFunc(cmd *cobra.Command, args []string) error {
140141
time.Sleep(time.Second * 5)
141142
continue
142143
} else if testPod.Status.Phase == v1.PodSucceeded {
143-
fmt.Printf("Test Successfully Completed\n")
144+
fmt.Println("Test Successfully Completed")
144145
return nil
145146
} else if testPod.Status.Phase == v1.PodFailed {
146147
req := kubeclient.CoreV1().Pods(tcConfig.namespace).GetLogs(testPod.Name, &v1.PodLogOptions{})

0 commit comments

Comments
 (0)