Adding the golangci-lint linter to the repository (jenkinsfile) #157

jlvoiseux · 2022-03-23T17:23:43Z

Resolves #153. The chosen linter is golangci-lint. For this third iteration, we install and run the linter as part of the Lint stage in the Jenkinsfile.

ghost · 2022-03-23T17:33:23Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-03-28T12:30:16.609+0000
Duration: 10 min 1 sec

Test stats 🧪

Test	Results
Failed	0
Passed	240
Skipped	6
Total	246

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

…/apm-aws-lambda into add-linter-jenkinsfile

jlvoiseux · 2022-03-24T14:06:33Z

Update on this PR : the linter was successfully implemented by commit 8907a3a.

Failing Linter output

11:54:39  + ./golangci-lint.sh
11:54:39  golangci/golangci-lint info checking GitHub for tag 'v1.45.0'
11:54:39  golangci/golangci-lint info found version: 1.45.0 for v1.45.0/linux/amd64
11:54:40  golangci/golangci-lint info installed /var/lib/jenkins/workspace/ibrary_apm-aws-lambda-mbp_PR-157/bin/golangci-lint
11:54:41  golangci-lint has version 1.45.0 built from 1f4c1ed9 on 2022-03-18T15:08:39Z
11:54:50  main.go:70:27: Error return value of `extension.StartHttpServer` is not checked (errcheck)
11:54:50  	extension.StartHttpServer(agentDataChannel, config)
11:54:50  	                         ^
11:54:50  main_test.go:168:12: Error return value of `client.Do` is not checked (errcheck)
11:54:50  		client.Do(reqData)
11:54:50  		         ^
11:54:50  main_test.go:189:14: Error return value of `client.Do` is not checked (errcheck)
11:54:50  				client.Do(reqData)
11:54:50  				         ^
11:54:50  e2e-testing/e2e_test.go:135:9: Error return value of `io.Copy` is not checked (errcheck)
11:54:50  	io.Copy(out, resp.Body)
11:54:50  	       ^
11:54:50  e2e-testing/e2e_test.go:150:11: Error return value of `os.Chmod` is not checked (errcheck)
11:54:50  		os.Chmod(filepath.Join(agentFolderPath, f.Name()), 0755)
11:54:50  		        ^
11:54:50  e2e-testing/e2e_util.go:38:9: Error return value of `e.Start` is not checked (errcheck)
11:54:50  	e.Start()
11:54:50  	       ^
11:54:50  e2e-testing/e2e_util.go:49:8: Error return value of `e.Wait` is not checked (errcheck)
11:54:50  	e.Wait()
11:54:50  	      ^
11:54:50  e2e-testing/e2e_util.go:78:13: Error return value of `os.MkdirAll` is not checked (errcheck)
11:54:50  	os.MkdirAll(destinationFolderPath, 0755)
11:54:50  	           ^
11:54:50  e2e-testing/e2e_util.go:100:15: Error return value of `os.MkdirAll` is not checked (errcheck)
11:54:50  			os.MkdirAll(path, f.Mode())
11:54:50  			           ^
11:54:50  e2e-testing/e2e_util.go:102:15: Error return value of `os.MkdirAll` is not checked (errcheck)
11:54:50  			os.MkdirAll(filepath.Dir(path), f.Mode())
11:54:50  			           ^
11:54:50  logsapi/subscribe.go:99:15: Error return value of `Server.Serve` is not checked (errcheck)
11:54:50  		Server.Serve(Listener)
11:54:50  		            ^
11:54:50  extension/apm_server_test.go:38:11: Error return value of `gw.Write` is not checked (errcheck)
11:54:50  		gw.Write([]byte(s))
11:54:50  		        ^
11:54:50  extension/apm_server_test.go:52:10: Error return value of `w.Write` is not checked (errcheck)
11:54:50  		w.Write([]byte(`{"foo": "bar"}`))
11:54:50  		       ^
11:54:50  extension/apm_server_test.go:74:11: Error return value of `gw.Write` is not checked (errcheck)
11:54:50  		gw.Write(body)
11:54:50  		        ^
11:54:50  extension/apm_server_test.go:85:10: Error return value of `w.Write` is not checked (errcheck)
11:54:50  		w.Write([]byte(`{"foo": "bar"}`))
11:54:50  		       ^
11:54:50  extension/apm_server_test.go:178:11: Error return value of `gw.Write` is not checked (errcheck)
11:54:50  		gw.Write([]byte(""))
11:54:50  		        ^
11:54:50  extension/apm_server_test.go:192:10: Error return value of `w.Write` is not checked (errcheck)
11:54:50  		w.Write([]byte(`{"foo": "bar"}`))
11:54:50  		       ^
11:54:50  extension/apm_server_test.go:201:17: Error return value is not checked (errcheck)
11:54:50  	PostToApmServer(apmServer.Client(), agentData, &config, context.Background())
11:54:50  	               ^
11:54:50  extension/apm_server_test.go:244:17: Error return value is not checked (errcheck)
11:54:50  	PostToApmServer(apmServer.Client(), agentData, &config, context.Background())
11:54:50  	               ^
11:54:50  extension/apm_server_test.go:285:17: Error return value is not checked (errcheck)
11:54:50  	PostToApmServer(apmServer.Client(), agentData, &config, context.Background())
11:54:50  	               ^
11:54:50  extension/apm_server_test.go:346:10: Error return value of `io.Copy` is not checked (errcheck)
11:54:50  		io.Copy(ioutil.Discard, r.Body)
11:54:50  		       ^
11:54:50  extension/http_server.go:48:24: Error return value of `agentDataServer.Serve` is not checked (errcheck)
11:54:50  		agentDataServer.Serve(ln)
11:54:50  		                     ^
11:54:50  e2e-testing/e2e_util.go:56:2: S1008: should use 'return err == nil' instead of 'if err == nil { return true }; return false' (gosimple)
11:54:50  	if err == nil {
11:54:50  	^
11:54:50  e2e-testing/e2e_test.go:46:16: S1028: should use fmt.Errorf(...) instead of errors.New(fmt.Sprintf(...)) (gosimple)
11:54:50  		ProcessError(errors.New(fmt.Sprintf("Unsupported language %s ! Supported languages are %v", languageName, supportedLanguages)))
11:54:50  		             ^
11:54:50  main_test.go:234:26: S1030: should use bufRecord.String() instead of string(bufRecord.Bytes()) (gosimple)
11:54:50  	logEvent.StringRecord = string(bufRecord.Bytes())
11:54:50  	                        ^

Corrections required for the linter to pass were done in ad51c2a.

Successful Linter output

14:56:58  + ./golangci-lint.sh
14:56:58  golangci/golangci-lint info checking GitHub for tag 'v1.45.0'
14:56:58  golangci/golangci-lint info found version: 1.45.0 for v1.45.0/linux/amd64
14:56:59  golangci/golangci-lint info installed /var/lib/jenkins/workspace/ibrary_apm-aws-lambda-mbp_PR-157/bin/golangci-lint
14:57:00  golangci-lint has version 1.45.0 built from 1f4c1ed9 on 2022-03-18T15:08:39Z

To run the linter on your own machine, just run the ./golangci-lint.sh script.

estolfo · 2022-03-28T09:40:36Z

apm-lambda-extension/e2e-testing/e2e_test.go

 	}

+	extension.Log.Info("If the end-to-end tests are failing unexpectedly, please verify that Docker is running on your machine.")
+


I'm assuming you put this because of a first-hand experience :)

estolfo

I just had a comment about using the shorthand ; err != nil {
That's not a necessary change, just up to you if you want to shave off some more lines of code.

estolfo · 2022-03-28T09:49:30Z

apm-lambda-extension/extension/apm_server_test.go

 		assert.Equal(t, string(data), string(bytes))
 		assert.Equal(t, "gzip", r.Header.Get("Content-Encoding"))
-		w.Write([]byte(`{"foo": "bar"}`))
+		_, err := w.Write([]byte(`{"foo": "bar"}`))


You could use this syntax in a few places in this PR, if you want:

if _, err := w.Write([]byte(`{"foo": "bar"}`)); err != nil { return }

estolfo · 2022-03-28T09:50:23Z

apm-lambda-extension/extension/apm_server_test.go

-		gw.Write([]byte(""))
-		gw.Close()
-		pw.Close()
+		_, err := gw.Write([]byte(""))


for example,

if _, err := gw.Write([]byte("")); err != nil { t.Fail() return }

Thanks for the advice ! In a34cd53 and 1bdfc14, I have used the shorthand wherever I could use it.

Download and run linter as part of CI

914d387

jlvoiseux changed the title ~~Adding the golangci-lint linter to the repository (makefile)~~ Adding the golangci-lint linter to the repository (jenkinsfile) Mar 23, 2022

github-actions bot added the aws-λ-extension AWS Lambda Extension label Mar 23, 2022

jlvoiseux added 12 commits March 23, 2022 18:37

Set golangci-lint output

4bfa1f4

Update golangci-lint output

c292ffc

Escape single quotes

e58605d

Split sh directive

abe5374

Remove unnecessary parentheses

840f51c

Adding separate linter shell script

1f04b36

Merge branch 'add-linter-jenkinsfile' of https://github.com/jlvoiseux…

ea03a03

…/apm-aws-lambda into add-linter-jenkinsfile

Update Jenkinsfile

e894649

Update permissions on shell script

97a4752

Merge branch 'add-linter-jenkinsfile' of https://github.com/jlvoiseux…

13937ad

…/apm-aws-lambda into add-linter-jenkinsfile

Simplify shell script

8907a3a

Implement changes required by linter

ad51c2a

jlvoiseux marked this pull request as ready for review March 24, 2022 14:06

jlvoiseux added 3 commits March 24, 2022 17:33

Move lint to makefile

4c98e84

Delete golangci-lint.sh

36b41f1

Update Jenkinsfile to reference make lint

152c36a

estolfo reviewed Mar 28, 2022

View reviewed changes

jlvoiseux added 2 commits March 28, 2022 14:28

Use error shorthand

a34cd53

Add missing error handling

1bdfc14

estolfo approved these changes Mar 28, 2022

View reviewed changes

jlvoiseux merged commit ffc7541 into elastic:main Mar 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding the golangci-lint linter to the repository (jenkinsfile) #157

Adding the golangci-lint linter to the repository (jenkinsfile) #157

Uh oh!

jlvoiseux commented Mar 23, 2022

Uh oh!

ghost commented Mar 23, 2022 •

edited by ghost

Loading

Build stats

Test stats 🧪

Uh oh!

jlvoiseux commented Mar 24, 2022

Uh oh!

estolfo Mar 28, 2022

Uh oh!

jlvoiseux Mar 28, 2022

Uh oh!

estolfo left a comment

Uh oh!

estolfo Mar 28, 2022

Uh oh!

estolfo Mar 28, 2022

Uh oh!

jlvoiseux Mar 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		}

		extension.Log.Info("If the end-to-end tests are failing unexpectedly, please verify that Docker is running on your machine.")

Adding the golangci-lint linter to the repository (jenkinsfile) #157

Adding the golangci-lint linter to the repository (jenkinsfile) #157

Uh oh!

Conversation

jlvoiseux commented Mar 23, 2022

Uh oh!

ghost commented Mar 23, 2022 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

🤖 GitHub comments

Uh oh!

jlvoiseux commented Mar 24, 2022

Uh oh!

estolfo Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

jlvoiseux Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

estolfo left a comment

Choose a reason for hiding this comment

Uh oh!

estolfo Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

estolfo Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

jlvoiseux Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ghost commented Mar 23, 2022 •

edited by ghost

Loading