-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
Copy pathpackage_test.go
834 lines (733 loc) · 22.5 KB
/
package_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package dev_tools
// This file contains tests that can be run on the generated packages.
// To run these tests use `go test package_test.go`.
import (
"archive/tar"
"archive/zip"
"bufio"
"bytes"
"compress/gzip"
"encoding/json"
"flag"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"regexp"
"strings"
"testing"
"github.com/blakesmith/ar"
rpm "github.com/cavaliercoder/go-rpm"
)
const (
expectedConfigMode = os.FileMode(0600)
expectedManifestMode = os.FileMode(0644)
expectedModuleFileMode = expectedManifestMode
expectedModuleDirMode = os.FileMode(0755)
)
var (
configFilePattern = regexp.MustCompile(`.*beat\.yml$|apm-server\.yml|elastic-agent\.yml$`)
manifestFilePattern = regexp.MustCompile(`manifest.yml`)
modulesDirPattern = regexp.MustCompile(`module/.+`)
modulesDDirPattern = regexp.MustCompile(`modules.d/$`)
modulesDFilePattern = regexp.MustCompile(`modules.d/.+`)
monitorsDFilePattern = regexp.MustCompile(`monitors.d/.+`)
systemdUnitFilePattern = regexp.MustCompile(`/lib/systemd/system/.*\.service`)
licenseFiles = []string{"LICENSE.txt", "NOTICE.txt"}
)
var (
files = flag.String("files", "../build/distributions/*/*", "filepath glob containing package files")
modules = flag.Bool("modules", false, "check modules folder contents")
minModules = flag.Int("min-modules", 4, "minimum number of modules to expect in modules folder")
modulesd = flag.Bool("modules.d", false, "check modules.d folder contents")
monitorsd = flag.Bool("monitors.d", false, "check monitors.d folder contents")
rootOwner = flag.Bool("root-owner", false, "expect root to own package files")
rootUserContainer = flag.Bool("root-user-container", false, "expect root in container user")
)
func TestRPM(t *testing.T) {
rpms := getFiles(t, regexp.MustCompile(`\.rpm$`))
for _, rpm := range rpms {
checkRPM(t, rpm)
}
}
func TestDeb(t *testing.T) {
debs := getFiles(t, regexp.MustCompile(`\.deb$`))
buf := new(bytes.Buffer)
for _, deb := range debs {
checkDeb(t, deb, buf)
}
}
func TestTar(t *testing.T) {
// Regexp matches *-arch.tar.gz, but not *-arch.docker.tar.gz
tars := getFiles(t, regexp.MustCompile(`-\w+\.tar\.gz$`))
for _, tar := range tars {
checkTar(t, tar)
}
}
func TestZip(t *testing.T) {
zips := getFiles(t, regexp.MustCompile(`^\w+beat-\S+.zip$`))
for _, zip := range zips {
checkZip(t, zip)
}
}
func TestDocker(t *testing.T) {
dockers := getFiles(t, regexp.MustCompile(`\.docker\.tar\.gz$`))
for _, docker := range dockers {
checkDocker(t, docker)
}
}
// Sub-tests
func checkRPM(t *testing.T, file string) {
p, rpmPkg, err := readRPM(file)
if err != nil {
t.Error(err)
return
}
checkConfigPermissions(t, p)
checkConfigOwner(t, p, *rootOwner)
checkManifestPermissions(t, p)
checkManifestOwner(t, p, *rootOwner)
checkModulesOwner(t, p, *rootOwner)
checkModulesPermissions(t, p)
checkModulesPresent(t, "/usr/share", p)
checkModulesDPresent(t, "/etc/", p)
checkMonitorsDPresent(t, "/etc", p)
checkLicensesPresent(t, "/usr/share", p)
checkSystemdUnitPermissions(t, p)
ensureNoBuildIDLinks(t, p)
checkRPMDigestTypeSHA256(t, rpmPkg)
}
func checkDeb(t *testing.T, file string, buf *bytes.Buffer) {
p, err := readDeb(file, buf)
if err != nil {
t.Error(err)
return
}
// deb file permissions are managed post-install
checkConfigPermissions(t, p)
checkConfigOwner(t, p, true)
checkManifestPermissions(t, p)
checkManifestOwner(t, p, true)
checkModulesPresent(t, "./usr/share", p)
checkModulesDPresent(t, "./etc/", p)
checkMonitorsDPresent(t, "./etc/", p)
checkLicensesPresent(t, "./usr/share", p)
checkModulesOwner(t, p, true)
checkModulesPermissions(t, p)
checkSystemdUnitPermissions(t, p)
}
func checkTar(t *testing.T, file string) {
p, err := readTar(file)
if err != nil {
t.Error(err)
return
}
checkConfigPermissions(t, p)
checkConfigOwner(t, p, true)
checkManifestPermissions(t, p)
checkModulesPresent(t, "", p)
checkModulesDPresent(t, "", p)
checkModulesPermissions(t, p)
checkModulesOwner(t, p, true)
checkLicensesPresent(t, "", p)
}
func checkZip(t *testing.T, file string) {
p, err := readZip(t, file, checkNpcapNotices)
if err != nil {
t.Error(err)
return
}
checkConfigPermissions(t, p)
checkManifestPermissions(t, p)
checkModulesPresent(t, "", p)
checkModulesDPresent(t, "", p)
checkModulesPermissions(t, p)
checkLicensesPresent(t, "", p)
}
const (
npcapSettings = "Windows Npcap installation settings"
npcapGrant = `Insecure.Com LLC \(“The Nmap Project”\) has granted Elasticsearch`
npcapLicense = `Dependency : Npcap \(https://nmap.org/npcap/\)`
libpcapLicense = `Dependency : Libpcap \(http://www.tcpdump.org/\)`
winpcapLicense = `Dependency : Winpcap \(https://www.winpcap.org/\)`
radiotapLicense = `Dependency : ieee80211_radiotap.h Header File`
)
// This reflects the order that the licenses and notices appear in the relevant files.
var npcapLicensePattern = regexp.MustCompile(
"(?s)" + npcapLicense +
".*" + libpcapLicense +
".*" + winpcapLicense +
".*" + radiotapLicense,
)
func checkNpcapNotices(pkg, file string, contents io.Reader) error {
if !strings.Contains(pkg, "packetbeat") {
return nil
}
wantNotices := strings.Contains(pkg, "windows") && !strings.Contains(pkg, "oss")
// If the packetbeat README.md is made to be generated
// conditionally then it should also be checked here.
pkg = filepath.Base(pkg)
file, err := filepath.Rel(pkg[:len(pkg)-len(filepath.Ext(pkg))], file)
if err != nil {
return err
}
switch file {
case "NOTICE.txt":
if npcapLicensePattern.MatchReader(bufio.NewReader(contents)) != wantNotices {
if wantNotices {
return fmt.Errorf("Npcap license section not found in %s file in %s", file, pkg)
}
return fmt.Errorf("unexpected Npcap license section found in %s file in %s", file, pkg)
}
}
return nil
}
func checkDocker(t *testing.T, file string) {
p, info, err := readDocker(file)
if err != nil {
t.Errorf("error reading file %v: %v", file, err)
return
}
checkDockerEntryPoint(t, p, info)
checkDockerLabels(t, p, info, file)
checkDockerUser(t, p, info, *rootUserContainer)
checkConfigPermissionsWithMode(t, p, os.FileMode(0644))
checkManifestPermissionsWithMode(t, p, os.FileMode(0644))
checkModulesPresent(t, "", p)
checkModulesDPresent(t, "", p)
checkLicensesPresent(t, "licenses/", p)
}
// Verify that the main configuration file is installed with a 0600 file mode.
func checkConfigPermissions(t *testing.T, p *packageFile) {
checkConfigPermissionsWithMode(t, p, expectedConfigMode)
}
func checkConfigPermissionsWithMode(t *testing.T, p *packageFile, expectedMode os.FileMode) {
t.Run(p.Name+" config file permissions", func(t *testing.T) {
for _, entry := range p.Contents {
if configFilePattern.MatchString(entry.File) {
mode := entry.Mode.Perm()
if expectedMode != mode {
t.Errorf("file %v has wrong permissions: expected=%v actual=%v",
entry.File, expectedMode, mode)
}
return
}
}
t.Errorf("no config file found matching %v", configFilePattern)
})
}
func checkOwner(t *testing.T, entry packageEntry, expectRoot bool) {
should := "not "
if expectRoot {
should = ""
}
if expectRoot != (entry.UID == 0) {
t.Errorf("file %v should %sbe owned by root user, owner=%v", entry.File, should, entry.UID)
}
if expectRoot != (entry.GID == 0) {
t.Errorf("file %v should %sbe owned by root group, group=%v", entry.File, should, entry.GID)
}
}
func checkConfigOwner(t *testing.T, p *packageFile, expectRoot bool) {
t.Run(p.Name+" config file owner", func(t *testing.T) {
for _, entry := range p.Contents {
if configFilePattern.MatchString(entry.File) {
checkOwner(t, entry, expectRoot)
return
}
}
t.Errorf("no config file found matching %v", configFilePattern)
})
}
// Verify that the modules manifest.yml files are installed with a 0644 file mode.
func checkManifestPermissions(t *testing.T, p *packageFile) {
checkManifestPermissionsWithMode(t, p, expectedManifestMode)
}
func checkManifestPermissionsWithMode(t *testing.T, p *packageFile, expectedMode os.FileMode) {
t.Run(p.Name+" manifest file permissions", func(t *testing.T) {
for _, entry := range p.Contents {
if manifestFilePattern.MatchString(entry.File) {
mode := entry.Mode.Perm()
if expectedMode != mode {
t.Errorf("file %v has wrong permissions: expected=%v actual=%v",
entry.File, expectedMode, mode)
}
}
}
})
}
// Verify that the manifest owner is correct.
func checkManifestOwner(t *testing.T, p *packageFile, expectRoot bool) {
t.Run(p.Name+" manifest file owner", func(t *testing.T) {
for _, entry := range p.Contents {
if manifestFilePattern.MatchString(entry.File) {
checkOwner(t, entry, expectRoot)
}
}
})
}
// Verify the permissions of the modules.d dir and its contents.
func checkModulesPermissions(t *testing.T, p *packageFile) {
t.Run(p.Name+" modules.d file permissions", func(t *testing.T) {
for _, entry := range p.Contents {
if modulesDFilePattern.MatchString(entry.File) {
mode := entry.Mode.Perm()
if expectedModuleFileMode != mode {
t.Errorf("file %v has wrong permissions: expected=%v actual=%v",
entry.File, expectedModuleFileMode, mode)
}
} else if modulesDDirPattern.MatchString(entry.File) {
mode := entry.Mode.Perm()
if expectedModuleDirMode != mode {
t.Errorf("file %v has wrong permissions: expected=%v actual=%v",
entry.File, expectedModuleDirMode, mode)
}
}
}
})
}
// Verify the owner of the modules.d dir and its contents.
func checkModulesOwner(t *testing.T, p *packageFile, expectRoot bool) {
t.Run(p.Name+" modules.d file owner", func(t *testing.T) {
for _, entry := range p.Contents {
if modulesDFilePattern.MatchString(entry.File) || modulesDDirPattern.MatchString(entry.File) {
checkOwner(t, entry, expectRoot)
}
}
})
}
// Verify that the systemd unit file has a mode of 0644. It should not be
// executable.
func checkSystemdUnitPermissions(t *testing.T, p *packageFile) {
const expectedMode = os.FileMode(0644)
t.Run(p.Name+" systemd unit file permissions", func(t *testing.T) {
for _, entry := range p.Contents {
if systemdUnitFilePattern.MatchString(entry.File) {
mode := entry.Mode.Perm()
if expectedMode != mode {
t.Errorf("file %v has wrong permissions: expected=%v actual=%v",
entry.File, expectedMode, mode)
}
return
}
}
t.Errorf("no systemd unit file found matching %v", configFilePattern)
})
}
// Verify that modules folder is present and has module files in
func checkModulesPresent(t *testing.T, prefix string, p *packageFile) {
if *modules {
checkModules(t, "modules", prefix, modulesDirPattern, p)
}
}
// Verify that modules.d folder is present and has module files in
func checkModulesDPresent(t *testing.T, prefix string, p *packageFile) {
if *modulesd {
checkModules(t, "modules.d", prefix, modulesDFilePattern, p)
}
}
func checkMonitorsDPresent(t *testing.T, prefix string, p *packageFile) {
if *monitorsd {
checkMonitors(t, "monitors.d", prefix, monitorsDFilePattern, p)
}
}
func checkModules(t *testing.T, name, prefix string, r *regexp.Regexp, p *packageFile) {
t.Run(fmt.Sprintf("%s %s contents", p.Name, name), func(t *testing.T) {
minExpectedModules := *minModules
total := 0
for _, entry := range p.Contents {
if strings.HasPrefix(entry.File, prefix) && r.MatchString(entry.File) {
total++
}
}
if total < minExpectedModules {
t.Errorf("not enough modules found under %s: actual=%d, expected>=%d",
name, total, minExpectedModules)
}
})
}
func checkMonitors(t *testing.T, name, prefix string, r *regexp.Regexp, p *packageFile) {
t.Run(fmt.Sprintf("%s %s contents", p.Name, name), func(t *testing.T) {
minExpectedModules := 1
total := 0
for _, entry := range p.Contents {
if strings.HasPrefix(entry.File, prefix) && r.MatchString(entry.File) {
total++
}
}
if total < minExpectedModules {
t.Errorf("not enough monitors found under %s: actual=%d, expected>=%d",
name, total, minExpectedModules)
}
})
}
func checkLicensesPresent(t *testing.T, prefix string, p *packageFile) {
for _, licenseFile := range licenseFiles {
t.Run("License file "+licenseFile, func(t *testing.T) {
for _, entry := range p.Contents {
if strings.HasPrefix(entry.File, prefix) && strings.HasSuffix(entry.File, "/"+licenseFile) {
return
}
}
if prefix != "" {
t.Fatalf("not found under %s", prefix)
}
t.Fatal("not found")
})
}
}
func checkDockerEntryPoint(t *testing.T, p *packageFile, info *dockerInfo) {
expectedMode := os.FileMode(0755)
t.Run(fmt.Sprintf("%s entrypoint", p.Name), func(t *testing.T) {
if len(info.Config.Entrypoint) == 0 {
t.Fatal("no entrypoint")
}
entrypoint := info.Config.Entrypoint[0]
if strings.HasPrefix(entrypoint, "/") {
entrypoint := strings.TrimPrefix(entrypoint, "/")
entry, found := p.Contents[entrypoint]
if !found {
t.Fatalf("%s entrypoint not found in docker", entrypoint)
}
if mode := entry.Mode.Perm(); mode != expectedMode {
t.Fatalf("%s entrypoint mode is %s, expected: %s", entrypoint, mode, expectedMode)
}
} else {
t.Fatal("TODO: check if binary is in $PATH")
}
})
}
func checkDockerLabels(t *testing.T, p *packageFile, info *dockerInfo, file string) {
vendor := info.Config.Labels["org.label-schema.vendor"]
if vendor != "Elastic" {
return
}
t.Run(fmt.Sprintf("%s license labels", p.Name), func(t *testing.T) {
expectedLicense := "Elastic License"
ossPrefix := strings.Join([]string{
info.Config.Labels["org.label-schema.name"],
"oss",
info.Config.Labels["org.label-schema.version"],
}, "-")
if strings.HasPrefix(filepath.Base(file), ossPrefix) {
expectedLicense = "ASL 2.0"
}
licenseLabels := []string{
"license",
"org.label-schema.license",
}
for _, licenseLabel := range licenseLabels {
if license, present := info.Config.Labels[licenseLabel]; !present || license != expectedLicense {
t.Errorf("unexpected license label %s: %s", licenseLabel, license)
}
}
})
t.Run(fmt.Sprintf("%s required labels", p.Name), func(t *testing.T) {
// From https://redhat-connect.gitbook.io/partner-guide-for-red-hat-openshift-and-container/program-on-boarding/technical-prerequisites
requiredLabels := []string{"name", "vendor", "version", "release", "summary", "description"}
for _, label := range requiredLabels {
if value, present := info.Config.Labels[label]; !present || value == "" {
t.Errorf("missing required label %s", label)
}
}
})
}
func checkDockerUser(t *testing.T, p *packageFile, info *dockerInfo, expectRoot bool) {
t.Run(fmt.Sprintf("%s user", p.Name), func(t *testing.T) {
if expectRoot != (info.Config.User == "root") {
t.Errorf("unexpected docker user: %s", info.Config.User)
}
})
}
// ensureNoBuildIDLinks checks for regressions related to
// https://github.com/elastic/beats/issues/12956.
func ensureNoBuildIDLinks(t *testing.T, p *packageFile) {
t.Run(fmt.Sprintf("%s no build_id links", p.Name), func(t *testing.T) {
for name := range p.Contents {
if strings.Contains(name, "/usr/lib/.build-id") {
t.Error("found unexpected /usr/lib/.build-id in package")
}
}
})
}
// checkRPMDigestTypeSHA256 verifies that the RPM contains sha256 digests.
// https://github.com/elastic/beats/issues/23670
func checkRPMDigestTypeSHA256(t *testing.T, rpmPkg *rpm.PackageFile) {
t.Run("rpm_digest_type_is_sha256", func(t *testing.T) {
if rpmPkg.ChecksumType() != "sha256" {
t.Errorf("expected SHA256 digest type but got %v", rpmPkg.ChecksumType())
}
})
}
// Helpers
type packageFile struct {
Name string
Contents map[string]packageEntry
}
type packageEntry struct {
File string
UID int
GID int
Mode os.FileMode
}
func getFiles(t *testing.T, pattern *regexp.Regexp) []string {
matches, err := filepath.Glob(*files)
if err != nil {
t.Fatal(err)
}
files := matches[:0]
for _, f := range matches {
if pattern.MatchString(filepath.Base(f)) {
files = append(files, f)
}
}
return files
}
func readRPM(rpmFile string) (*packageFile, *rpm.PackageFile, error) {
p, err := rpm.OpenPackageFile(rpmFile)
if err != nil {
return nil, nil, err
}
contents := p.Files()
pf := &packageFile{Name: filepath.Base(rpmFile), Contents: map[string]packageEntry{}}
for _, file := range contents {
pe := packageEntry{
File: file.Name(),
Mode: file.Mode(),
}
if file.Owner() != "root" {
// not 0
pe.UID = 123
pe.GID = 123
}
pf.Contents[file.Name()] = pe
}
return pf, p, nil
}
// readDeb reads the data.tar.gz file from the .deb.
func readDeb(debFile string, dataBuffer *bytes.Buffer) (*packageFile, error) {
file, err := os.Open(debFile)
if err != nil {
return nil, err
}
defer file.Close()
arReader := ar.NewReader(file)
for {
header, err := arReader.Next()
if err != nil {
if err == io.EOF {
break
}
return nil, err
}
if strings.HasPrefix(header.Name, "data.tar.gz") {
dataBuffer.Reset()
_, err := io.Copy(dataBuffer, arReader)
if err != nil {
return nil, err
}
gz, err := gzip.NewReader(dataBuffer)
if err != nil {
return nil, err
}
defer gz.Close()
return readTarContents(filepath.Base(debFile), gz)
}
}
return nil, io.EOF
}
func readTar(tarFile string) (*packageFile, error) {
file, err := os.Open(tarFile)
if err != nil {
return nil, err
}
defer file.Close()
var fileReader io.ReadCloser = file
if strings.HasSuffix(tarFile, ".gz") {
if fileReader, err = gzip.NewReader(file); err != nil {
return nil, err
}
defer fileReader.Close()
}
return readTarContents(filepath.Base(tarFile), fileReader)
}
func readTarContents(tarName string, data io.Reader) (*packageFile, error) {
tarReader := tar.NewReader(data)
p := &packageFile{Name: tarName, Contents: map[string]packageEntry{}}
for {
header, err := tarReader.Next()
if err != nil {
if err == io.EOF {
break
}
return nil, err
}
p.Contents[header.Name] = packageEntry{
File: header.Name,
UID: header.Uid,
GID: header.Gid,
Mode: os.FileMode(header.Mode),
}
}
return p, nil
}
// inspector is a file contents inspector. It vets the contents of the file
// within a package for a requirement and returns an error if it is not met.
type inspector func(pkg, file string, contents io.Reader) error
func readZip(t *testing.T, zipFile string, inspectors ...inspector) (*packageFile, error) {
r, err := zip.OpenReader(zipFile)
if err != nil {
return nil, err
}
defer r.Close()
p := &packageFile{Name: filepath.Base(zipFile), Contents: map[string]packageEntry{}}
for _, f := range r.File {
p.Contents[f.Name] = packageEntry{
File: f.Name,
Mode: f.Mode(),
}
for _, inspect := range inspectors {
r, err := f.Open()
if err != nil {
t.Errorf("failed to open %s in %s: %v", f.Name, zipFile, err)
break
}
err = inspect(zipFile, f.Name, r)
if err != nil {
t.Error(err)
}
r.Close()
}
}
return p, nil
}
func readDocker(dockerFile string) (*packageFile, *dockerInfo, error) {
file, err := os.Open(dockerFile)
if err != nil {
return nil, nil, err
}
defer file.Close()
var manifest *dockerManifest
var info *dockerInfo
layers := make(map[string]*packageFile)
gzipReader, err := gzip.NewReader(file)
if err != nil {
return nil, nil, err
}
defer gzipReader.Close()
tarReader := tar.NewReader(gzipReader)
for {
header, err := tarReader.Next()
if err != nil {
if err == io.EOF {
break
}
return nil, nil, err
}
switch {
case header.Name == "manifest.json":
manifest, err = readDockerManifest(tarReader)
if err != nil {
return nil, nil, err
}
case strings.HasSuffix(header.Name, ".json") && header.Name != "manifest.json":
info, err = readDockerInfo(tarReader)
if err != nil {
return nil, nil, err
}
case strings.HasSuffix(header.Name, "/layer.tar"):
layer, err := readTarContents(header.Name, tarReader)
if err != nil {
return nil, nil, err
}
layers[filepath.Dir(header.Name)] = layer
}
}
if len(info.Config.Entrypoint) == 0 {
return nil, nil, fmt.Errorf("no entrypoint")
}
workingDir := info.Config.WorkingDir
entrypoint := info.Config.Entrypoint[0]
// Read layers in order and for each file keep only the entry seen in the later layer
p := &packageFile{Name: filepath.Base(dockerFile), Contents: map[string]packageEntry{}}
for _, layer := range manifest.Layers {
layerID := filepath.Dir(layer)
layerFile, found := layers[layerID]
if !found {
return nil, nil, fmt.Errorf("layer not found: %s", layerID)
}
for name, entry := range layerFile.Contents {
// Check only files in working dir and entrypoint
if strings.HasPrefix("/"+name, workingDir) || "/"+name == entrypoint {
p.Contents[name] = entry
}
// Add also licenses
for _, licenseFile := range licenseFiles {
if strings.Contains(name, licenseFile) {
p.Contents[name] = entry
}
}
}
}
if len(p.Contents) == 0 {
return nil, nil, fmt.Errorf("no files found in docker working directory (%s)", info.Config.WorkingDir)
}
return p, info, nil
}
type dockerManifest struct {
Config string
RepoTags []string
Layers []string
}
func readDockerManifest(r io.Reader) (*dockerManifest, error) {
data, err := ioutil.ReadAll(r)
if err != nil {
return nil, err
}
var manifests []*dockerManifest
err = json.Unmarshal(data, &manifests)
if err != nil {
return nil, err
}
if len(manifests) != 1 {
return nil, fmt.Errorf("one and only one manifest expected, %d found", len(manifests))
}
return manifests[0], nil
}
type dockerInfo struct {
Config struct {
Entrypoint []string
Labels map[string]string
User string
WorkingDir string
} `json:"config"`
}
func readDockerInfo(r io.Reader) (*dockerInfo, error) {
data, err := ioutil.ReadAll(r)
if err != nil {
return nil, err
}
var info dockerInfo
err = json.Unmarshal(data, &info)
if err != nil {
return nil, err
}
return &info, nil
}