Skip to content

Commit fc202f4

Browse files
per1234per1234
committed
Use Arduino Lint to validate releases
Arduino Lint allows library maintainers to use the same tool locally and in CI as will be used to validate the library submission and its releases. This provides transparency for the whole process and should reduce the Library Manager index support burden.
1 parent c395aaf commit fc202f4

36 files changed

+1024
-16
lines changed

Diff for: ‎.github/workflows/test-go.yml

+14
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,20 @@ jobs:
6262
with:
6363
go-version: "1.14"
6464

65+
- name: Install Arduino Lint
66+
run: |
67+
ARDUINO_LINT_INSTALLATION_PATH="${{ runner.temp }}/arduino-lint"
68+
mkdir --parents "$ARDUINO_LINT_INSTALLATION_PATH"
69+
curl \
70+
-fsSL \
71+
https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh \
72+
| \
73+
BINDIR="$ARDUINO_LINT_INSTALLATION_PATH" \
74+
sh
75+
76+
# Add installation folder to path to path
77+
echo "$ARDUINO_LINT_INSTALLATION_PATH" >> "$GITHUB_PATH"
78+
6579
- name: Install Taskfile
6680
uses: arduino/actions/setup-taskfile@master
6781
with:

Diff for: ‎libraries/lint.go

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
// This file is part of libraries-repository-engine.
2+
//
3+
// Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
4+
//
5+
// This program is free software: you can redistribute it and/or modify
6+
// it under the terms of the GNU Affero General Public License as published
7+
// by the Free Software Foundation, either version 3 of the License, or
8+
// (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful,
11+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
// GNU Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public License
16+
// along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
//
18+
// You can be released from the requirements of the above licenses by purchasing
19+
// a commercial license. Buying such a license is mandatory if you want to
20+
// modify or otherwise use the software for commercial activities involving the
21+
// Arduino software without disclosing the source code of your own applications.
22+
// To purchase a commercial license, send an email to [email protected].
23+
24+
package libraries
25+
26+
import (
27+
"encoding/json"
28+
"fmt"
29+
"io/ioutil"
30+
"os"
31+
"os/exec"
32+
"path/filepath"
33+
)
34+
35+
var empty struct{}
36+
37+
var officialTypes = map[string]struct{}{
38+
"Arduino": empty,
39+
}
40+
41+
func official(metadata *Repo) bool {
42+
for _, libraryType := range metadata.Types {
43+
_, isOfficial := officialTypes[libraryType]
44+
if isOfficial {
45+
return true
46+
}
47+
}
48+
return false
49+
}
50+
51+
// RunArduinoLint runs Arduino Lint on the library and returns the report in the event of error or warnings.
52+
func RunArduinoLint(folder string, metadata *Repo) ([]byte, error) {
53+
JSONReportFolder, err := ioutil.TempDir("", "arduino-lint-report-")
54+
if err != nil {
55+
panic(err)
56+
}
57+
JSONReportPath := filepath.Join(JSONReportFolder, "report.json")
58+
defer os.RemoveAll(JSONReportPath)
59+
60+
// See: https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/
61+
cmd := exec.Command(
62+
"arduino-lint",
63+
"--compliance=permissive",
64+
"--format=text",
65+
"--project-type=library",
66+
"--recursive=false",
67+
"--report-file="+JSONReportPath,
68+
folder,
69+
)
70+
// See: https://arduino.github.io/arduino-lint/latest/#environment-variables
71+
cmd.Env = modifyEnv(os.Environ(), "ARDUINO_LINT_LIBRARY_MANAGER_INDEXING", "true")
72+
cmd.Env = modifyEnv(cmd.Env, "ARDUINO_LINT_OFFICIAL", fmt.Sprintf("%t", official(metadata)))
73+
74+
textReport, lintErr := cmd.CombinedOutput()
75+
if lintErr != nil {
76+
return textReport, lintErr
77+
}
78+
79+
// Read report.
80+
rawJSONReport, err := ioutil.ReadFile(JSONReportPath)
81+
if err != nil {
82+
panic(err)
83+
}
84+
var JSONReport map[string]interface{}
85+
if err := json.Unmarshal(rawJSONReport, &JSONReport); err != nil {
86+
panic(err)
87+
}
88+
89+
// Check warning count.
90+
reportSummary := JSONReport["summary"].(map[string]interface{})
91+
warningCount := reportSummary["warningCount"].(float64)
92+
93+
// Report should be displayed when there are warnings.
94+
if warningCount > 0 {
95+
return textReport, lintErr
96+
}
97+
98+
// No warnings.
99+
return nil, nil
100+
}

Diff for: ‎libraries/lint_test.go

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
// This file is part of libraries-repository-engine.
2+
//
3+
// Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
4+
//
5+
// This program is free software: you can redistribute it and/or modify
6+
// it under the terms of the GNU Affero General Public License as published
7+
// by the Free Software Foundation, either version 3 of the License, or
8+
// (at your option) any later version.
9+
//
10+
// This program is distributed in the hope that it will be useful,
11+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
// GNU Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public License
16+
// along with this program. If not, see <https://www.gnu.org/licenses/>.
17+
//
18+
// You can be released from the requirements of the above licenses by purchasing
19+
// a commercial license. Buying such a license is mandatory if you want to
20+
// modify or otherwise use the software for commercial activities involving the
21+
// Arduino software without disclosing the source code of your own applications.
22+
// To purchase a commercial license, send an email to [email protected].
23+
24+
package libraries
25+
26+
import (
27+
"os"
28+
"path/filepath"
29+
"regexp"
30+
"testing"
31+
32+
"github.com/stretchr/testify/assert"
33+
)
34+
35+
var testDataPath string
36+
37+
func init() {
38+
workingDirectory, err := os.Getwd()
39+
if err != nil {
40+
panic(err)
41+
}
42+
testDataPath = filepath.Join(workingDirectory, "testdata")
43+
}
44+
45+
func TestRunArduinoLint(t *testing.T) {
46+
testTables := []struct {
47+
testName string
48+
folder string
49+
official bool
50+
reportRegexp string
51+
errorAssertion assert.ErrorAssertionFunc
52+
}{
53+
{
54+
"update",
55+
"Arduino_MKRRGB",
56+
true,
57+
"^$",
58+
assert.NoError,
59+
},
60+
{
61+
"official",
62+
"Arduino_TestOff",
63+
true,
64+
"^$",
65+
assert.NoError,
66+
},
67+
{
68+
"unofficial",
69+
"Arduino_Test3rd",
70+
false,
71+
"LP012",
72+
assert.NoError,
73+
},
74+
{
75+
"error",
76+
"Arduino_TestErr",
77+
true,
78+
"LS006",
79+
assert.Error,
80+
},
81+
{
82+
"warning",
83+
"Arduino_TestWarn",
84+
true,
85+
"LP015",
86+
assert.NoError,
87+
},
88+
{
89+
"pass",
90+
"Arduino_TestPass",
91+
true,
92+
"^$",
93+
assert.NoError,
94+
},
95+
}
96+
97+
for _, testTable := range testTables {
98+
var metadata Repo
99+
if testTable.official {
100+
metadata.Types = []string{"Arduino"}
101+
} else {
102+
metadata.Types = []string{"Contributed"}
103+
}
104+
report, err := RunArduinoLint(filepath.Join(testDataPath, "libraries", testTable.folder), &metadata)
105+
assert.Regexp(t, regexp.MustCompile(testTable.reportRegexp), string(report), testTable.testName)
106+
testTable.errorAssertion(t, err, testTable.testName)
107+
}
108+
}

Diff for: ‎libraries/repoclone.go

-11
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
package libraries
2525

2626
import (
27-
"errors"
2827
"io/ioutil"
2928
"os"
3029
"path/filepath"
@@ -100,16 +99,6 @@ func GenerateLibraryFromRepo(repo *Repository) (*metadata.LibraryMetadata, error
10099
return nil, err
101100
}
102101

103-
libraryErrors := library.Validate()
104-
if len(libraryErrors) > 0 {
105-
var errorsString []string
106-
for _, error := range libraryErrors {
107-
errorsString = append(errorsString, error.Error())
108-
}
109-
combinedErrors := strings.Join(errorsString, ",")
110-
return nil, errors.New(combinedErrors)
111-
}
112-
113102
return library, nil
114103
}
115104

Diff for: ‎libraries/testdata/libraries/Arduino_MKRRGB/LICENSE.txt

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

Diff for: ‎libraries/testdata/libraries/Arduino_MKRRGB/README.md

Whitespace-only changes.

Diff for: ‎libraries/testdata/libraries/Arduino_MKRRGB/examples/Example/Example.ino

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
void setup() {}
2+
void loop() {}

Diff for: ‎libraries/testdata/libraries/Arduino_MKRRGB/library.properties

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=Arduino_MKRRGB
2+
version=1.0.0
3+
author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
4+
maintainer=Cristian Maglie <[email protected]>
5+
sentence=A library that makes coding a Webserver a breeze.
6+
paragraph=Supports HTTP1.1 and you can do GET and POST.
7+
category=Communication
8+
url=http://example.com/
9+
architectures=avr

Diff for: ‎libraries/testdata/libraries/Arduino_MKRRGB/src/Arduino_MKRRGB.h

Whitespace-only changes.

0 commit comments

Comments
 (0)