Lint tasks refactory (#250)

* replace golangci-lint with govet and golint go-task task

going in the direction of removing travis.ci in favour of drone io,
and in order to have a clean linting check output, golangci-lint was
removed because the output for this codebase was too confusing

* refactor task check and add task check-legacy

in order to be aligned with test task style we will have a legacy
(ugly) lint output if requested and meanwhile  we will focus on the
"new refactored part" of the code with lint and fmt to speed up
the development and refactoring

* removed go lint check for legacy lint task

no need to be obsessed on linting for a module that will be properly
refactored out from the legacy

* add dynamic DEFAULT_TARGET generation list

* replace golangci-lint with simple go-task check

* fix upload for integ and unit test in codeconv.io

* raise to 10m test timeput for unit and integ tests

* add task test-unit-race to specificly run unit test with rece condition
detection

in order to do not slow down testing too much also because we do not
have particular race conditions to detect at the moment

* clean from drone configuration and related dockerfiles

* add missing documentation temporary comment to make linter happy

this is a FIXME commit, in next months all the FIXMEDOCS placeholders
must be replaced with proper documentation

Author: rsora

.golangci.yml

@@ -9,23 +9,21 @@ env:
 # Anything in before_script that returns a nonzero exit code will flunk the
 # build and immediately stop. It's sorta like having set -e enabled in bash.
 # Make sure golangci-lint is vendored.
-before_install:
-  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s -- -b $GOPATH/bin v1.16.0
+install:
   - curl -sL https://taskfile.dev/install.sh | sh
-
-install: true
+  - go get github.com/golangci/govet
+  - go get golang.org/x/lint/golint
 
 script:
-  # Check if the code is formatted
-  - $(exit $(go fmt ./... | wc -l))
-  # Run linter
-  - golangci-lint run
+  # Check if the code is formatted and run linter
+  - ./bin/task check
   # Build and test
   - ./bin/task build
   - ./bin/task test
   - ./bin/task test-legacy
 
 after_success:
-  - bash <(curl -s https://codecov.io/bash) -cF unittests,integration
+  - bash <(curl -s https://codecov.io/bash) -cF unit -f '*_unit.txt'
+  - bash <(curl -s https://codecov.io/bash) -cF integ -f '*_integ.txt'
 
 

.travis.yml

@@ -344,9 +344,13 @@ Currently Unit and Integration test are available for launch in 2 ways:
 
 ```
 * build:                Build the project
-* test:                 Run the full testsuite
+* check:                Check fmt and lint, `legacy` will be skipped
+* check-legacy:         Check fmt and lint for the `legacy` package
+* test:                 Run the full testsuite, `legacy` will be skipped
 * test-integration:     Run integration tests only
+* test-legacy:          Run tests for the `legacy` package
 * test-unit:            Run unit tests only
+* test-unit-race:       Run unit tests only with race condition detection
 ```
 
 For Example to launch unit tests only run: `task test-unit` 

README.md

@@ -27,8 +27,28 @@ tasks:
     cmds:
       - go test {{ default "-v" .GOFLAGS }} ./legacy/...
 
+  test-unit-race:
+    desc: Run unit tests only with race condition detection
+    cmds:
+      - go test -short -race {{ default "-v" .GOFLAGS }} -coverprofile=coverage_race_unit.txt {{ default .DEFAULT_TARGETS .TARGETS }}
+
+  check:
+    desc: Check fmt and lint, `legacy` will be skipped
+    cmds:
+      - test -z $(go fmt {{ default .DEFAULT_TARGETS .TARGETS }})
+      - go vet {{ default .DEFAULT_TARGETS .TARGETS }}
+      - golint {{.GOLINTFLAGS}} {{ default .DEFAULT_TARGETS .TARGETS }}
+
+  check-legacy:
+    desc: Check fmt and lint for the `legacy` package
+    cmds:
+      - test -z $(go fmt ./legacy/...)
+      - go vet ./legacy/...
+
 vars:
-  DEFAULT_TARGETS: "./arduino/... ./auth/... ./cli/... ./commands/... ./executils/... ./version/..."
+  # all modules of this project except for "legacy/..." module
+  DEFAULT_TARGETS:
+    sh: echo `go list ./... | grep -v legacy | tr '\n' ' '`
 
   # build vars
   VERSIONSTRING: "0.3.6-alpha.preview"
@@ -39,9 +59,12 @@ vars:
       -X github.com/arduino/arduino-cli/version.commit={{.COMMIT}}'
 
   # test vars
-  GOFLAGS: "-timeout 5m -v -coverpkg=./... -covermode=atomic"
+  GOFLAGS: "-timeout 10m -v -coverpkg=./... -covermode=atomic"
   TEST_VERSIONSTRING: "0.0.0-test.preview"
   TEST_COMMIT: "deadbeef"
   TEST_LDFLAGS: >
     -ldflags  '-X github.com/arduino/arduino-cli/version.versionString={{.TEST_VERSIONSTRING}}
-    -X github.com/arduino/arduino-cli/version.commit={{.TEST_COMMIT}}'
+    -X github.com/arduino/arduino-cli/version.commit={{.TEST_COMMIT}}'
+
+  # check-lint vars
+  GOLINTFLAGS: "-min_confidence 0.8 -set_exit_status"

Taskfile.yml

@@ -27,7 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/configs"
 	"github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
-	"go.bug.st/relaxed-semver"
+	semver "go.bug.st/relaxed-semver"
 )
 
 // LoadHardware read all plaforms from the configured paths
@@ -361,6 +361,7 @@ func (pm *PackageManager) loadToolReleasesFromTool(tool *cores.Tool, toolPath *p
 	return nil
 }
 
+// LoadToolsFromBundleDirectories FIXMEDOC
 func (pm *PackageManager) LoadToolsFromBundleDirectories(dirs paths.PathList) error {
 	for _, dir := range dirs {
 		if err := pm.LoadToolsFromBundleDirectory(dir); err != nil {
@@ -370,6 +371,7 @@ func (pm *PackageManager) LoadToolsFromBundleDirectories(dirs paths.PathList) er
 	return nil
 }
 
+// LoadToolsFromBundleDirectory FIXMEDOC
 func (pm *PackageManager) LoadToolsFromBundleDirectory(toolsPath *paths.Path) error {
 	pm.Log.Infof("Loading tools from bundle dir: %s", toolsPath)
 

arduino/cores/packagemanager/loader.go

@@ -59,14 +59,17 @@ func NewPackageManager(indexDir, packagesDir, downloadDir, tempDir *paths.Path)
 	}
 }
 
+// Clear FIXMEDOC
 func (pm *PackageManager) Clear() {
 	pm.packages = cores.NewPackages()
 }
 
+// GetPackages FIXMEDOC
 func (pm *PackageManager) GetPackages() *cores.Packages {
 	return pm.packages
 }
 
+// FindPlatformReleaseProvidingBoardsWithVidPid FIXMEDOC
 func (pm *PackageManager) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid string) []*cores.PlatformRelease {
 	res := []*cores.PlatformRelease{}
 	for _, targetPackage := range pm.packages.Packages {
@@ -86,6 +89,7 @@ func (pm *PackageManager) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid
 	return res
 }
 
+// FindBoardsWithVidPid FIXMEDOC
 func (pm *PackageManager) FindBoardsWithVidPid(vid, pid string) []*cores.Board {
 	res := []*cores.Board{}
 	for _, targetPackage := range pm.packages.Packages {
@@ -102,6 +106,7 @@ func (pm *PackageManager) FindBoardsWithVidPid(vid, pid string) []*cores.Board {
 	return res
 }
 
+// FindBoardsWithID FIXMEDOC
 func (pm *PackageManager) FindBoardsWithID(id string) []*cores.Board {
 	res := []*cores.Board{}
 	for _, targetPackage := range pm.packages.Packages {
@@ -290,6 +295,7 @@ func (ta *ToolActions) IsInstalled() (bool, error) {
 	return false, nil
 }
 
+// Release FIXMEDOC
 func (ta *ToolActions) Release(version *semver.RelaxedVersion) *ToolReleaseActions {
 	if ta.forwardError != nil {
 		return &ToolReleaseActions{forwardError: ta.forwardError}
@@ -310,6 +316,7 @@ type ToolReleaseActions struct {
 	forwardError error
 }
 
+// Get FIXMEDOC
 func (tr *ToolReleaseActions) Get() (*cores.ToolRelease, error) {
 	if tr.forwardError != nil {
 		return nil, tr.forwardError
@@ -340,6 +347,7 @@ func (pm *PackageManager) GetInstalledPlatformRelease(platform *cores.Platform)
 	return best
 }
 
+// GetAllInstalledToolsReleases FIXMEDOC
 func (pm *PackageManager) GetAllInstalledToolsReleases() []*cores.ToolRelease {
 	tools := []*cores.ToolRelease{}
 	for _, targetPackage := range pm.packages.Packages {
@@ -384,6 +392,7 @@ func (pm *PackageManager) InstalledBoards() []*cores.Board {
 	return boards
 }
 
+// FindToolsRequiredForBoard FIXMEDOC
 func (pm *PackageManager) FindToolsRequiredForBoard(board *cores.Board) ([]*cores.ToolRelease, error) {
 	pm.Log.Infof("Searching tools required for board %s", board)
 
@@ -421,6 +430,7 @@ func (pm *PackageManager) FindToolsRequiredForBoard(board *cores.Board) ([]*core
 	return requiredTools, nil
 }
 
+// FindToolDependency FIXMEDOC
 func (pm *PackageManager) FindToolDependency(dep *cores.ToolDependency) *cores.ToolRelease {
 	toolRelease, err := pm.Package(dep.ToolPackager).Tool(dep.ToolName).Release(dep.ToolVersion).Get()
 	if err != nil {

arduino/cores/packagemanager/package_manager.go

@@ -26,8 +26,13 @@ import (
 	semver "go.bug.st/relaxed-semver"
 )
 
+// MandatoryProperties FIXMEDOC
 var MandatoryProperties = []string{"name", "version", "author", "maintainer"}
+
+// OptionalProperties FIXMEDOC
 var OptionalProperties = []string{"sentence", "paragraph", "url"}
+
+// ValidCategories FIXMEDOC
 var ValidCategories = map[string]bool{
 	"Display":             true,
 	"Communication":       true,

arduino/libraries/libraries.go

@@ -58,6 +58,7 @@ var appName = filepath.Base(os.Args[0])
 // VersionInfo contains all info injected during build
 var VersionInfo = version.NewInfo(appName)
 
+// HTTPClientHeader is the object that will be propagated to configure the clients inside the downloaders
 var HTTPClientHeader = getHTTPClientHeader()
 
 // ErrLogrus represents the logrus instance, which has the role to
@@ -70,6 +71,7 @@ var GlobalFlags struct {
 	OutputJSON bool // true output in JSON, false output as Text
 }
 
+// Config FIXMEDOC
 var Config *configs.Configuration
 
 func packageManagerInitReq() *rpc.InitReq {
@@ -96,6 +98,7 @@ func getHTTPClientHeader() http.Header {
 	return downloaderHeaders
 }
 
+// InitInstance FIXMEDOC
 func InitInstance() *rpc.InitResp {
 	logrus.Info("Initializing package manager")
 	req := packageManagerInitReq()

cli/cli.go

@@ -34,6 +34,7 @@ import (
 	paths "github.com/arduino/go-paths-helper"
 )
 
+// Attach FIXMEDOC
 func Attach(ctx context.Context, req *rpc.BoardAttachReq, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResp, error) {
 
 	pm := commands.GetPackageManager(req)

commands/board/attach.go

@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// Details FIXMEDOC
 func Details(ctx context.Context, req *rpc.BoardDetailsReq) (*rpc.BoardDetailsResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/board/details.go

@@ -26,6 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// List FIXMEDOC
 func List(ctx context.Context, req *rpc.BoardListReq) (*rpc.BoardListResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/board/list.go

@@ -26,6 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// ListAll FIXMEDOC
 func ListAll(ctx context.Context, req *rpc.BoardListAllReq) (*rpc.BoardListAllResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/board/listall.go

@@ -40,6 +40,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// Compile FIXMEDOC
 func Compile(ctx context.Context, req *rpc.CompileReq, outStream io.Writer, errStream io.Writer) (*rpc.CompileResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/compile/compile.go

@@ -29,6 +29,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformDownload FIXMEDOC
 func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadReq, downloadCB commands.DownloadProgressCB,
 	downloaderHeaders http.Header) (*rpc.PlatformDownloadResp, error) {
 	pm := commands.GetPackageManager(req)

commands/core/download.go

@@ -29,6 +29,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformInstall FIXMEDOC
 func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallReq,
 	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB, downloaderHeaders http.Header) (*rpc.PlatformInstallResp, error) {
 

commands/core/install.go

@@ -25,6 +25,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformList FIXMEDOC
 func PlatformList(ctx context.Context, req *rpc.PlatformListReq) (*rpc.PlatformListResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/core/list.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformSearch FIXMEDOC
 func PlatformSearch(ctx context.Context, req *rpc.PlatformSearchReq) (*rpc.PlatformSearchResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/core/search.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformUninstall FIXMEDOC
 func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallReq, taskCB commands.TaskProgressCB) (*rpc.PlatformUninstallResp, error) {
 	pm := commands.GetPackageManager(req)
 	if pm == nil {

commands/core/uninstall.go

@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/rpc"
 )
 
+// PlatformUpgrade FIXMEDOC
 func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeReq,
 	downloadCB commands.DownloadProgressCB, taskCB commands.TaskProgressCB, downloaderHeaders http.Header) (*rpc.PlatformUpgradeResp, error) {