all: add golangci.yaml and fix errors (#28)

.github/workflows/golangci-lint.yaml

@@ -0,0 +1,26 @@
+# Copyright 2023 Adevinta
+
+name: Golangci-lint
+on: [push, pull_request]
+permissions:
+  contents: read
+jobs:
+  golangci-lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    env:
+      GOLANGCI_LINT_VERSION: v1.54.2
+      GOLANGCI_LINT_OUT_FORMAT: ${{ github.event_name == 'pull_request' && 'github-actions' || 'colored-line-number' }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'
+      - name: Remove Go problem matchers
+        run: echo "::remove-matcher owner=go::"
+      - name: Install "golangci-lint"
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${{ env.GOLANGCI_LINT_VERSION }}
+      - name: Run "golangci-lint run"
+        run: golangci-lint run --out-format=${{ env.GOLANGCI_LINT_OUT_FORMAT }} ./...

.gitignore

@@ -17,16 +17,9 @@ vulcan-tracker
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
-.vscode/
 out/
 
-
 dist/
-.env
-.DS_Store
-.history
-.idea
-
 
 # generated run toml config
 run.toml

.golangci.yaml

@@ -0,0 +1,38 @@
+linters:
+  enable:
+    - gci
+    - godot
+    - gofmt
+    - goheader
+    - misspell
+    - revive
+    - whitespace
+    - unparam
+linters-settings:
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/adevinta/vulcan-tracker)
+    custom-order: true
+  goheader:
+    values:
+      const:
+        COMPANY: Adevinta
+      regexp:
+        ANY-YEAR: \d{4}
+    template: |-
+      Copyright {{ ANY-YEAR }} {{ COMPANY }}
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  exclude-use-default: false
+  exclude-rules:
+    - linters:
+        - errcheck
+      text: 'Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked'
+    - linters:
+        - revive
+      text: 'unused-parameter: parameter ''.*'' seems to be unused'
+run:
+  timeout: 5m

cmd/vulcan-tracker/main.go

@@ -2,6 +2,7 @@
 Copyright 2022 Adevinta
 */
 
+// Package main start a vulcan-tracker server.
 package main
 
 import (

pkg/api/api.go

@@ -2,11 +2,10 @@
 Copyright 2022 Adevinta
 */
 
+// Package api contains the endpoints to manage finding tickets.
 package api
 
 import (
-	"errors"
-
 	"github.com/adevinta/vulcan-tracker/pkg/storage"
 	"github.com/adevinta/vulcan-tracker/pkg/tracking"
 )
@@ -25,37 +24,6 @@ type Options struct {
 	DefaultSize int
 }
 
-// Pagination represents the pagination options for the API requests.
-type Pagination struct {
-	Limit  int  `json:"limit"`
-	Offset int  `json:"offset"`
-	Total  int  `json:"total"`
-	More   bool `json:"more"`
-}
-
-var (
-	// Regular expression matching date format 'yyyy-mm-dd'.
-	dateFmtRegEx = `^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$`
-
-	// ErrDateMalformed indicates that the date format does not comply with YYYY-MM-DD.
-	ErrDateMalformed = errors.New("malformed Date")
-
-	// ErrPageMalformed indicates that the page requested is not an integer larger than 0.
-	ErrPageMalformed = errors.New("malformed Page Number")
-
-	// ErrPageNotFound indicates that the page requested does not exist.
-	ErrPageNotFound = errors.New("page Not Found")
-
-	// ErrSizeMalformed indicates that the size requested is not an integer larger than 0.
-	ErrSizeMalformed = errors.New("malformed Size Number")
-
-	// ErrSizeTooLarge indicates that the size requested is larger than the maximum allowed.
-	ErrSizeTooLarge = errors.New("size Number Too Large")
-
-	// ErrInvalidFilter indicates that there is a conflict between specified params for the filter.
-	ErrInvalidFilter = errors.New("filter parameters combination is invalid")
-)
-
 // New instantiates a new API.
 func New(ticketServer tracking.TicketServer, ticketTrackerBuilder tracking.TicketTrackerBuilder,
 	storage storage.Storage, options Options) *API {

pkg/api/tracking.go

@@ -1,6 +1,7 @@
 /*
 Copyright 2023 Adevinta
 */
+
 package api
 
 import (
@@ -113,7 +114,7 @@ func (api *API) CreateTicket(c echo.Context) error {
 	ticket.TicketType = configuration.VulnerabilityIssueType
 
 	// Check if the ticket exists.
-	findingTicket, err := api.storage.GetFindingTicket(ticket.FindingID, ticket.TeamID)
+	findingTicket, _ := api.storage.GetFindingTicket(ticket.FindingID, ticket.TeamID)
 	if findingTicket.ID != "" {
 		return echo.NewHTTPError(http.StatusConflict, "The ticket for this finding and team already exists.")
 	}

pkg/api/tracking_test.go

@@ -1,6 +1,7 @@
 /*
 Copyright 2022 Adevinta
 */
+
 package api
 
 import (
@@ -12,12 +13,13 @@ import (
 	"net/http/httptest"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+	"github.com/labstack/echo/v4"
+
 	vterrors "github.com/adevinta/vulcan-tracker/pkg/errors"
 	"github.com/adevinta/vulcan-tracker/pkg/model"
 	"github.com/adevinta/vulcan-tracker/pkg/storage"
 	"github.com/adevinta/vulcan-tracker/pkg/tracking"
-	"github.com/google/go-cmp/cmp"
-	"github.com/labstack/echo/v4"
 )
 
 const (

pkg/config/config.go

@@ -2,17 +2,19 @@
 Copyright 2022 Adevinta
 */
 
+// Package config parses and validates the configuration
+// needed to run vulcan-tracker.
 package config
 
 import (
 	"io"
 	"os"
 	"strconv"
 
-	"github.com/adevinta/vulcan-tracker/pkg/storage/postgresql"
-
 	"github.com/BurntSushi/toml"
 	"github.com/labstack/gommon/log"
+
+	"github.com/adevinta/vulcan-tracker/pkg/storage/postgresql"
 )
 
 // Config represents all the configuration needed to run the project.
@@ -33,7 +35,7 @@ type logConfig struct {
 	Level string `toml:"level"`
 }
 
-// AwsConfig stores the AWS configuration
+// AwsConfig stores the AWS configuration.
 type AwsConfig struct {
 	ServerCredentialsKey string `toml:"server_credentials_key"`
 	Region               string `toml:"region"`

pkg/errors/errors.go

@@ -1,6 +1,8 @@
 /*
 Copyright 2022 Adevinta
 */
+
+// Package errors manage the errors for vulcan-tracker.
 package errors
 
 // TrackingError represents a custom error for this project.

pkg/model/model.go

@@ -2,6 +2,7 @@
 Copyright 2002 Adevinta
 */
 
+// Package model represents the data model for vulcan-tracker.
 package model
 
 // Ticket represents a vulnerability in a ticket tracker.

pkg/secrets/secrets.go

@@ -2,21 +2,22 @@
 Copyright 2023 Adevinta
 */
 
+// Package secrets manages the storage of credentials for ticket trackers.
 package secrets
 
 import (
 	"encoding/json"
 	"fmt"
 	"net/http"
 
-	"github.com/adevinta/vulcan-tracker/pkg/config"
-	vterrors "github.com/adevinta/vulcan-tracker/pkg/errors"
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/secretsmanager"
+	"github.com/aws/aws-secretsmanager-caching-go/secretcache"
 	"github.com/labstack/echo/v4"
 
-	"github.com/aws/aws-secretsmanager-caching-go/secretcache"
+	"github.com/adevinta/vulcan-tracker/pkg/config"
+	vterrors "github.com/adevinta/vulcan-tracker/pkg/errors"
 )
 
 // Secrets manage the credentials of ticket trackers servers.

pkg/secrets/secrets_test.go

@@ -12,15 +12,16 @@ import (
 	"testing"
 	"time"
 
-	"github.com/adevinta/vulcan-tracker/pkg/config"
-	"github.com/adevinta/vulcan-tracker/pkg/testutil"
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/request"
 	"github.com/aws/aws-sdk-go/service/secretsmanager"
 	"github.com/aws/aws-sdk-go/service/secretsmanager/secretsmanageriface"
 	"github.com/aws/aws-secretsmanager-caching-go/secretcache"
 	"github.com/google/go-cmp/cmp"
 	"github.com/labstack/echo/v4"
+
+	"github.com/adevinta/vulcan-tracker/pkg/config"
+	"github.com/adevinta/vulcan-tracker/pkg/testutil"
 )
 
 type smMock struct {

pkg/storage/postgresql/postgresql.go

@@ -2,6 +2,7 @@
 Copyright 2023 Adevinta
 */
 
+// Package postgresql manage the storage in a PostgreSQL database.
 package postgresql
 
 import (
@@ -92,7 +93,7 @@ func (db *PostgresStore) Healthcheck() error {
 	return nil
 }
 
-// Close closes PostgresStore db connection
+// Close closes PostgresStore db connection.
 func (db *PostgresStore) Close() error {
 	return db.DB.Close()
 }

pkg/storage/postgresql/postgresql_test.go

@@ -1,10 +1,15 @@
+/*
+Copyright 2023 Adevinta
+*/
+
 package postgresql
 
 import (
 	"testing"
 
-	"github.com/adevinta/vulcan-tracker/pkg/testutil"
 	"github.com/google/go-cmp/cmp"
+
+	"github.com/adevinta/vulcan-tracker/pkg/testutil"
 )
 
 func errToStr(err error) string {

pkg/storage/postgresql/tickets.go

@@ -5,11 +5,12 @@ Copyright 2023 Adevinta
 package postgresql
 
 import (
-	"github.com/adevinta/vulcan-tracker/pkg/model"
 	"github.com/lib/pq"
+
+	"github.com/adevinta/vulcan-tracker/pkg/model"
 )
 
-// FindingTicket represents
+// FindingTicket represents a relation between tickets and findings.
 type FindingTicket struct {
 	model.FindingTicket
 	CreatedAt pq.NullTime `db:"created_at"`

pkg/storage/postgresql/tickets_test.go

@@ -8,10 +8,11 @@ import (
 	"database/sql"
 	"testing"
 
-	"github.com/adevinta/vulcan-tracker/pkg/model"
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"github.com/labstack/gommon/log"
+
+	"github.com/adevinta/vulcan-tracker/pkg/model"
 )
 
 var (

pkg/storage/postgresql/ticketserver_test.go

@@ -8,9 +8,10 @@ import (
 	"database/sql"
 	"testing"
 
-	"github.com/adevinta/vulcan-tracker/pkg/model"
 	"github.com/google/go-cmp/cmp"
 	"github.com/labstack/gommon/log"
+
+	"github.com/adevinta/vulcan-tracker/pkg/model"
 )
 
 func TestFindServerConf(t *testing.T) {

pkg/storage/storage.go

@@ -1,6 +1,8 @@
 /*
 Copyright 2022 Adevinta
 */
+
+// Package storage manage the data storage in a database.
 package storage
 
 import "github.com/adevinta/vulcan-tracker/pkg/model"

pkg/testutil/testutils.go

@@ -1,6 +1,8 @@
 /*
 Copyright 2022 Adevinta
 */
+
+// Package testutil provide utils for testing.
 package testutil
 
 // ErrToStr returns a string even when it is nil.

pkg/tracking/jira/client.go

@@ -1,17 +1,18 @@
 /*
 Copyright 2022 Adevinta
 */
+
 package jira
 
 import (
 	"fmt"
 	"net/http"
 	"strings"
 
+	gojira "github.com/andygrunwald/go-jira"
+
 	vterrors "github.com/adevinta/vulcan-tracker/pkg/errors"
 	"github.com/adevinta/vulcan-tracker/pkg/model"
-
-	gojira "github.com/andygrunwald/go-jira"
 )
 
 // Issuer manages all the operations related with the ticket tracker issues.