Skip to content

Commit ff21544

Browse files
MattWindsor91MattWindsor91
committed
Do a linting pass
1 parent ad69379 commit ff21544

File tree

7 files changed

+66
-78
lines changed

7 files changed

+66
-78
lines changed

‎internal/gen/catkin/catkin.go‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ import (
77
"os"
88
"path/filepath"
99

10-
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
11-
12-
"github.com/UoY-RoboStar/rtcg/internal/gen/templating"
13-
1410
cfg "github.com/UoY-RoboStar/rtcg/internal/gen/config/catkin"
1511
"github.com/UoY-RoboStar/rtcg/internal/gen/gencommon"
12+
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
13+
"github.com/UoY-RoboStar/rtcg/internal/gen/templating"
1614
"github.com/UoY-RoboStar/rtcg/internal/stm"
1715
)
1816

@@ -90,16 +88,20 @@ func (o *OnSuite) generateTest(dirs gencommon.DirSet, name string) error {
9088
return err
9189
}
9290

93-
return o.parent.cmakeGen.Generate(dirs.Output, pkg)
91+
if err := o.parent.cmakeGen.Generate(dirs.Output, pkg); err != nil {
92+
return fmt.Errorf("generating cmake: %w", err)
93+
}
94+
95+
return nil
9496
}
9597

9698
func generatePackageXML(dir string, pkg cfg.Package) error {
97-
w, err := os.Create(filepath.Join(dir, "package.xml"))
99+
file, err := os.Create(filepath.Join(dir, "package.xml"))
98100
if err != nil {
99101
return fmt.Errorf("couldn't create package.xml: %w", err)
100102
}
101103

102-
err = pkg.Write(w)
104+
err = pkg.Write(file)
103105

104-
return errors.Join(err, w.Close())
106+
return errors.Join(err, file.Close())
105107
}

‎internal/gen/config/catkin/package_test.go‎

Lines changed: 26 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,7 @@ func TestPackage_Autofill(t *testing.T) {
1616
want catkin.Package
1717
}{
1818
"empty": {
19-
input: catkin.Package{
20-
XMLName: xml.Name{Space: "", Local: ""},
21-
Format: 0,
22-
Name: "",
23-
Version: "",
24-
Description: "",
25-
Maintainer: catkin.Maintainer{Email: "", Name: ""},
26-
License: "",
27-
BuildtoolDepends: nil,
28-
Depends: nil,
29-
},
19+
input: emptyCatkin(),
3020
want: catkin.Package{
3121
XMLName: xml.Name{Space: "", Local: ""},
3222
Format: 2,
@@ -41,17 +31,17 @@ func TestPackage_Autofill(t *testing.T) {
4131
},
4232
}
4333

44-
for name, tt := range tests {
34+
for name, test := range tests {
4535
name := name
46-
tt := tt
36+
test := test
4737

4838
t.Run(name, func(t *testing.T) {
4939
t.Parallel()
5040

51-
got := tt.input
41+
got := test.input
5242
got.Autofill()
5343

54-
cmp(t, got, tt.want)
44+
cmp(t, got, test.want)
5545
})
5646
}
5747
}
@@ -60,32 +50,11 @@ func TestPackage_Expand(t *testing.T) {
6050
t.Parallel()
6151

6252
tests := map[string]struct {
63-
input catkin.Package
64-
want catkin.Package
53+
input, want catkin.Package
6554
}{
6655
"empty": {
67-
input: catkin.Package{
68-
XMLName: xml.Name{Space: "", Local: ""},
69-
Format: 0,
70-
Name: "",
71-
Version: "",
72-
Description: "",
73-
Maintainer: catkin.Maintainer{Email: "", Name: ""},
74-
License: "",
75-
BuildtoolDepends: nil,
76-
Depends: nil,
77-
},
78-
want: catkin.Package{
79-
XMLName: xml.Name{Space: "", Local: ""},
80-
Format: 0,
81-
Name: "",
82-
Version: "",
83-
Description: "",
84-
Maintainer: catkin.Maintainer{Email: "", Name: ""},
85-
License: "",
86-
BuildtoolDepends: nil,
87-
Depends: nil,
88-
},
56+
input: emptyCatkin(),
57+
want: emptyCatkin(),
8958
},
9059
"minimal": {
9160
input: catkin.Package{
@@ -113,21 +82,35 @@ func TestPackage_Expand(t *testing.T) {
11382
},
11483
}
11584

116-
for name, tt := range tests {
85+
for name, test := range tests {
11786
name := name
118-
tt := tt
87+
test := test
11988

12089
t.Run(name, func(t *testing.T) {
12190
t.Parallel()
12291

123-
got := tt.input
92+
got := test.input
12493
got.Expand("foobar")
12594

126-
cmp(t, got, tt.want)
95+
cmp(t, got, test.want)
12796
})
12897
}
12998
}
13099

100+
func emptyCatkin() catkin.Package {
101+
return catkin.Package{
102+
XMLName: xml.Name{Space: "", Local: ""},
103+
Format: 0,
104+
Name: "",
105+
Version: "",
106+
Description: "",
107+
Maintainer: catkin.Maintainer{Email: "", Name: ""},
108+
License: "",
109+
BuildtoolDepends: nil,
110+
Depends: nil,
111+
}
112+
}
113+
131114
// TODO: Write
132115

133116
func cmp(t *testing.T, got, want catkin.Package) {

‎internal/gen/cpp/cpp.go‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ package cpp
44
import (
55
"fmt"
66

7-
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
8-
97
cfg "github.com/UoY-RoboStar/rtcg/internal/gen/config/cpp"
108
"github.com/UoY-RoboStar/rtcg/internal/gen/gencommon"
9+
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
1110
"github.com/UoY-RoboStar/rtcg/internal/stm"
1211
)
1312

@@ -59,7 +58,7 @@ func (o *OnSuite) Parent() subgen.Subgenerator {
5958
}
6059

6160
func (o *OnSuite) Dirs() []string {
62-
dirs := make([]string, 1, len(o.suite.Tests)+2)
61+
dirs := make([]string, 1, len(o.suite.Tests)+1)
6362
dirs[0] = o.parent.srcDirSet.OutputPath(preludeDir)
6463

6564
if o.cctx.HasConversion {
@@ -100,7 +99,11 @@ func (o *OnSuite) generateCommon() error {
10099
return err
101100
}
102101

103-
return o.parent.templated.common.Generate(o.parent.srcDirSet.Output, o.cctx)
102+
if err := o.parent.templated.common.Generate(o.parent.srcDirSet.Output, o.cctx); err != nil {
103+
return fmt.Errorf("generating common files: %w", err)
104+
}
105+
106+
return nil
104107
}
105108

106109
// copyConvertFile copies convert.cpp from the input directory, if there is one.
@@ -127,5 +130,9 @@ func (o *OnSuite) generateTestSpecific() error {
127130
func (o *OnSuite) generateTest(dirs gencommon.DirSet, name string, test *stm.Stm) error {
128131
ctx := NewContext(name, test, o.cctx)
129132

130-
return o.parent.templated.testSpecific.Generate(dirs.Output, ctx)
133+
if err := o.parent.templated.testSpecific.Generate(dirs.Output, ctx); err != nil {
134+
return fmt.Errorf("generating test-specific files: %w", err)
135+
}
136+
137+
return nil
131138
}

‎internal/gen/cpp/template.go‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ import (
55
"fmt"
66
"io/fs"
77

8-
"github.com/UoY-RoboStar/rtcg/internal/gen/templating"
9-
108
cfg "github.com/UoY-RoboStar/rtcg/internal/gen/config/cpp"
9+
"github.com/UoY-RoboStar/rtcg/internal/gen/templating"
1110
)
1211

1312
var (
@@ -43,19 +42,19 @@ func makeTemplatedGenerators(config *cfg.Config) (templatedGenerators, error) {
4342
}
4443

4544
var (
46-
tg templatedGenerators
47-
err error
45+
gens templatedGenerators
46+
err error
4847
)
4948

50-
if tg.common, err = templating.NewGenerator(commonFiles, builder); err != nil {
51-
return tg, fmt.Errorf("couldn't create C++ template-based common files generator: %w", err)
49+
if gens.common, err = templating.NewGenerator(commonFiles, builder); err != nil {
50+
return gens, fmt.Errorf("couldn't create C++ template-based common files generator: %w", err)
5251
}
5352

54-
if tg.testSpecific, err = templating.NewGenerator(testSpecificFiles, builder); err != nil {
55-
return tg, fmt.Errorf("couldn't create C++ template-based test files generator: %w", err)
53+
if gens.testSpecific, err = templating.NewGenerator(testSpecificFiles, builder); err != nil {
54+
return gens, fmt.Errorf("couldn't create C++ template-based test files generator: %w", err)
5655
}
5756

58-
return tg, nil
57+
return gens, nil
5958
}
6059

6160
func variantSource(variant cfg.Variant) templating.Source {

‎internal/gen/gen.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ import (
55
"fmt"
66
"os"
77

8-
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
9-
108
"github.com/UoY-RoboStar/rtcg/internal/gen/catkin"
119
"github.com/UoY-RoboStar/rtcg/internal/gen/config"
1210
cfg "github.com/UoY-RoboStar/rtcg/internal/gen/config/cpp"
1311
"github.com/UoY-RoboStar/rtcg/internal/gen/cpp"
1412
"github.com/UoY-RoboStar/rtcg/internal/gen/gencommon"
1513
"github.com/UoY-RoboStar/rtcg/internal/gen/makefile"
14+
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
1615
"github.com/UoY-RoboStar/rtcg/internal/stm"
1716
)
1817

@@ -118,7 +117,6 @@ func New(cfg config.Config, outputDir string) (*Generator, error) {
118117

119118
func (g *Generator) OnSuite(suite *stm.Suite) *OnSuite {
120119
// TODO(@MattWindsor91): possibly make this return a subgen.OnSuite
121-
122120
subgens := make([]subgen.OnSuite, len(g.subgens))
123121

124122
for i, subg := range g.subgens {

‎internal/gen/gencommon/dirset_test.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ func TestDirSet_OutputPath(t *testing.T) {
2828
want: filepath.Join("bar", "src"),
2929
},
3030
}
31-
for name, tt := range tests {
31+
for name, test := range tests {
3232
name := name
33-
tt := tt
33+
test := test
3434

3535
t.Run(name, func(t *testing.T) {
3636
t.Parallel()
3737

38-
if got := tt.input.OutputPath("src"); got != tt.want {
39-
t.Errorf("OutputPath(\"src\") of %s: got %v, want %v", name, got, tt.want)
38+
if got := test.input.OutputPath("src"); got != test.want {
39+
t.Errorf("OutputPath(\"src\") of %s: got %v, want %v", name, got, test.want)
4040
}
4141
})
4242
}
@@ -72,15 +72,15 @@ func TestDirSet_Subdir(t *testing.T) {
7272
},
7373
}
7474

75-
for name, tt := range tests {
75+
for name, test := range tests {
7676
name := name
77-
tt := tt
77+
test := test
7878

7979
t.Run(name, func(t *testing.T) {
8080
t.Parallel()
8181

82-
if got := tt.input.Subdir(tt.dir); !reflect.DeepEqual(got, tt.want) {
83-
t.Errorf("%s: got %v, want %v", name, got, tt.want)
82+
if got := test.input.Subdir(test.dir); !reflect.DeepEqual(got, test.want) {
83+
t.Errorf("%s: got %v, want %v", name, got, test.want)
8484
}
8585
})
8686
}

‎internal/gen/makefile/makefile.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ import (
66
"path/filepath"
77
"text/template"
88

9-
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
10-
119
"github.com/UoY-RoboStar/rtcg/internal/gen/config/cpp"
1210
"github.com/UoY-RoboStar/rtcg/internal/gen/gencommon"
11+
"github.com/UoY-RoboStar/rtcg/internal/gen/subgen"
1312
"github.com/UoY-RoboStar/rtcg/internal/gen/templating"
1413
"github.com/UoY-RoboStar/rtcg/internal/stm"
1514
)

0 commit comments

Comments
 (0)