search

anchore / stereoscope

go library for processing container images and simulating a squash filesystem
Apache License 2.0
78 stars 43 forks source link

docs: CODE_OF_CONDUCT.md #272

Closed popey closed 1 month ago

popey commented 1 month ago

This PR adds a code of conduct document to the repo, as agreed at our recent OSS team catch up.

github-actions[bot] commented 1 month ago

Benchmark Test Results

Benchmark results from the latest changes vs base branch ``` make .tool/task make[1]: Entering directory '/home/runner/work/stereoscope/stereoscope' make[1]: Leaving directory '/home/runner/work/stereoscope/stereoscope' .tool/task show-benchstat ? github.com/anchore/stereoscope [no test files] ? github.com/anchore/stereoscope/examples [no test files] PASS ok github.com/anchore/stereoscope/internal 0.003s ? github.com/anchore/stereoscope/internal/bus [no test files] PASS ok github.com/anchore/stereoscope/internal/containerd 0.008s PASS ok github.com/anchore/stereoscope/internal/docker 0.005s ? github.com/anchore/stereoscope/internal/log [no test files] PASS ok github.com/anchore/stereoscope/internal/podman 0.006s ? github.com/anchore/stereoscope/pkg/event [no test files] ? github.com/anchore/stereoscope/pkg/event/parsers [no test files] goos: linux goarch: amd64 pkg: github.com/anchore/stereoscope/pkg/file cpu: AMD EPYC 7763 64-Core Processor BenchmarkTarIndex-4 33388 35992 ns/op 5699 B/op 93 allocs/op BenchmarkTarIndex-4 30829 36143 ns/op 5700 B/op 93 allocs/op BenchmarkTarIndex-4 33320 36003 ns/op 5699 B/op 93 allocs/op BenchmarkTarIndex-4 32871 35937 ns/op 5697 B/op 93 allocs/op BenchmarkTarIndex-4 33254 35921 ns/op 5699 B/op 93 allocs/op BenchmarkTarIndex-4 33099 36012 ns/op 5700 B/op 93 allocs/op BenchmarkTarIndex-4 33175 35932 ns/op 5701 B/op 93 allocs/op PASS ok github.com/anchore/stereoscope/pkg/file 10.880s PASS ok github.com/anchore/stereoscope/pkg/filetree 0.005s ? github.com/anchore/stereoscope/pkg/filetree/filenode [no test files] PASS ok github.com/anchore/stereoscope/pkg/image 0.005s PASS ok github.com/anchore/stereoscope/pkg/image/containerd 0.011s PASS ok github.com/anchore/stereoscope/pkg/image/docker 0.006s PASS ok github.com/anchore/stereoscope/pkg/image/oci 0.006s PASS ok github.com/anchore/stereoscope/pkg/image/oci/credhelpers 0.005s ? github.com/anchore/stereoscope/pkg/image/podman [no test files] PASS ok github.com/anchore/stereoscope/pkg/image/sif 0.005s ? github.com/anchore/stereoscope/pkg/imagetest [no test files] PASS ok github.com/anchore/stereoscope/pkg/tree 0.003s PASS ok github.com/anchore/stereoscope/pkg/tree/node 0.003s goos: linux goarch: amd64 pkg: github.com/anchore/stereoscope/test/integration cpu: AMD EPYC 7763 64-Core Processor BenchmarkSimpleImage_GetImage/docker-archive-4 1040 1219977 ns/op 282996 B/op 2274 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1078 1118703 ns/op 282464 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1072 1108347 ns/op 282455 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1082 1104316 ns/op 282365 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1083 1131952 ns/op 282326 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1072 1168357 ns/op 282167 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/docker-archive-4 1078 1167551 ns/op 282259 B/op 2273 allocs/op BenchmarkSimpleImage_GetImage/podman-4 68 17241822 ns/op 410818 B/op 2675 allocs/op BenchmarkSimpleImage_GetImage/podman-4 68 17577645 ns/op 409646 B/op 2672 allocs/op BenchmarkSimpleImage_GetImage/podman-4 68 17871651 ns/op 410169 B/op 2674 allocs/op BenchmarkSimpleImage_GetImage/podman-4 67 18726964 ns/op 409637 B/op 2673 allocs/op BenchmarkSimpleImage_GetImage/podman-4 66 17446921 ns/op 409837 B/op 2673 allocs/op BenchmarkSimpleImage_GetImage/podman-4 66 17270587 ns/op 408692 B/op 2671 allocs/op BenchmarkSimpleImage_GetImage/podman-4 69 17599145 ns/op 409600 B/op 2672 allocs/op #0 building with "default" instance using docker driver #1 [internal] load build definition from Dockerfile #1 transferring dockerfile: 345B done #1 DONE 0.0s #2 [internal] load .dockerignore #2 transferring context: 2B done #2 DONE 0.0s #3 [internal] load build context #3 transferring context: 209B done #3 DONE 0.0s #4 [2/3] ADD file-2.txt /somefile-2.txt #4 CACHED #5 [1/3] ADD file-1.txt /somefile-1.txt #5 CACHED #6 [3/3] ADD target / #6 CACHED #7 exporting to image #7 exporting layers done #7 writing image sha256:2f79966962befd1ec81dae492d2a4a97785c9e39605609d8cac579afd54672e9 done #7 naming to docker.io/library/stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 done #7 naming to docker.io/library/stereoscope-fixture-image-simple:latest done #7 DONE 0.0s ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied" --- FAIL: BenchmarkSimpleImage_GetImage image_fixtures.go:193: using existing image tar: 'test-fixtures/cache/stereoscope-fixture-image-simple-04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7.tar' (size: 22528, modified: 2024-07-17 08:57:32.045317895 +0000 UTC, mode: -rw-r--r--) image_fixtures.go:241: Build docker image: name="stereoscope-fixture-image-simple" tag="04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7" image_fixtures.go:291: saveImage running: docker image save stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 image_fixtures.go:286: Error Trace: /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:286 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:162 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:152 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:33 /home/runner/work/stereoscope/stereoscope/test/integration/fixture_image_simple_test.go:163 Error: Received unexpected error: exit status 1 Test: BenchmarkSimpleImage_GetImage Messages: could not import docker image to containerd (shell out) BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 54463 22091 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 54139 22210 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 53047 22098 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 53632 22221 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 53835 22317 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 54004 22152 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4 53679 22183 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 53490 22101 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 53821 22119 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 54241 22113 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 53678 22113 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 53298 22471 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 54063 22218 ns/op 2712 B/op 21 allocs/op BenchmarkSimpleImage_FetchSquashedContents/podman-4 53713 22213 ns/op 2712 B/op 21 allocs/op #0 building with "default" instance using docker driver #1 [internal] load build definition from Dockerfile #1 transferring dockerfile: 345B done #1 DONE 0.0s #2 [internal] load .dockerignore #2 transferring context: 2B done #2 DONE 0.0s #3 [internal] load build context #3 transferring context: 209B done #3 DONE 0.0s #4 [1/3] ADD file-1.txt /somefile-1.txt #4 CACHED #5 [2/3] ADD file-2.txt /somefile-2.txt #5 CACHED #6 [3/3] ADD target / #6 CACHED #7 exporting to image #7 exporting layers done #7 writing image sha256:2f79966962befd1ec81dae492d2a4a97785c9e39605609d8cac579afd54672e9 done #7 naming to docker.io/library/stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 done #7 naming to docker.io/library/stereoscope-fixture-image-simple:latest done #7 DONE 0.0s ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied" --- FAIL: BenchmarkSimpleImage_FetchSquashedContents image_fixtures.go:193: using existing image tar: 'test-fixtures/cache/stereoscope-fixture-image-simple-04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7.tar' (size: 22528, modified: 2024-07-17 08:57:32.045317895 +0000 UTC, mode: -rw-r--r--) image_fixtures.go:241: Build docker image: name="stereoscope-fixture-image-simple" tag="04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7" image_fixtures.go:291: saveImage running: docker image save stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 image_fixtures.go:286: Error Trace: /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:286 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:162 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:152 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:33 /home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:64 /home/runner/work/stereoscope/stereoscope/test/integration/fixture_image_simple_test.go:189 Error: Received unexpected error: exit status 1 Test: BenchmarkSimpleImage_FetchSquashedContents Messages: could not import docker image to containerd (shell out) FAIL exit status 1 FAIL github.com/anchore/stereoscope/test/integration 39.438s ? github.com/anchore/stereoscope/test/integration/test-fixtures/registry [no test files] FAIL goos: linux goarch: amd64 pkg: github.com/anchore/stereoscope/pkg/file cpu: AMD EPYC 7763 64-Core Processor ctr: │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ TarIndex-4 35.99µ ± 0% │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ TarIndex-4 5.565Ki ± 0% │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ TarIndex-4 93.00 ± 0% pkg: github.com/anchore/stereoscope/test/integration │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ SimpleImage_GetImage/docker-archive-4 1.132m ± 8% SimpleImage_GetImage/podman-4 17.58m ± 7% geomean 4.461m │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ SimpleImage_GetImage/docker-archive-4 275.7Ki ± 0% SimpleImage_GetImage/podman-4 400.0Ki ± 0% geomean 332.1Ki │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ SimpleImage_GetImage/docker-archive-4 2.273k ± 0% SimpleImage_GetImage/podman-4 2.673k ± 0% geomean 2.465k ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied" │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ SimpleImage_FetchSquashedContents/docker-archive-4 22.18µ ± 1% SimpleImage_FetchSquashedContents/podman-4 22.12µ ± 2% geomean 22.15µ │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ SimpleImage_FetchSquashedContents/docker-archive-4 2.648Ki ± 0% SimpleImage_FetchSquashedContents/podman-4 2.648Ki ± 0% geomean 2.648Ki │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ SimpleImage_FetchSquashedContents/docker-archive-4 21.00 ± 0% SimpleImage_FetchSquashedContents/podman-4 21.00 ± 0% geomean 21.00 goos: linux goarch: amd64 pkg: github.com/anchore/stereoscope/pkg/file cpu: AMD EPYC 7763 64-Core Processor ctr: │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ TarIndex-4 35.99µ ± 0% │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ TarIndex-4 5.565Ki ± 0% │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ TarIndex-4 93.00 ± 0% pkg: github.com/anchore/stereoscope/test/integration │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ SimpleImage_GetImage/docker-archive-4 1.132m ± 8% SimpleImage_GetImage/podman-4 17.58m ± 7% geomean 4.461m │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ SimpleImage_GetImage/docker-archive-4 275.7Ki ± 0% SimpleImage_GetImage/podman-4 400.0Ki ± 0% geomean 332.1Ki │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ SimpleImage_GetImage/docker-archive-4 2.273k ± 0% SimpleImage_GetImage/podman-4 2.673k ± 0% geomean 2.465k ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied" │ .tmp/benchmark-2dec6fe.txt │ │ sec/op │ SimpleImage_FetchSquashedContents/docker-archive-4 22.18µ ± 1% SimpleImage_FetchSquashedContents/podman-4 22.12µ ± 2% geomean 22.15µ │ .tmp/benchmark-2dec6fe.txt │ │ B/op │ SimpleImage_FetchSquashedContents/docker-archive-4 2.648Ki ± 0% SimpleImage_FetchSquashedContents/podman-4 2.648Ki ± 0% geomean 2.648Ki │ .tmp/benchmark-2dec6fe.txt │ │ allocs/op │ SimpleImage_FetchSquashedContents/docker-archive-4 21.00 ± 0% SimpleImage_FetchSquashedContents/podman-4 21.00 ± 0% geomean 21.00 ```