Introduced matrix save-load test (#1552)

integration/load_test.go

@@ -1,111 +0,0 @@
-package integration
-
-import (
-	"fmt"
-	"net/http"
-	"os"
-	"path"
-	"path/filepath"
-	"testing"
-
-	"github.com/imgproxy/imgproxy/v3/imagetype"
-	"github.com/imgproxy/imgproxy/v3/testutil"
-	"github.com/imgproxy/imgproxy/v3/vips"
-	"github.com/stretchr/testify/suite"
-)
-
-const (
-	maxDistance = 0 // maximum image distance
-)
-
-type LoadTestSuite struct {
-	Suite
-
-	matcher           *testutil.ImageHashMatcher
-	testImagesPath    string
-	saveTmpImagesPath string
-}
-
-func (s *LoadTestSuite) SetupTest() {
-	s.testImagesPath = s.TestData.Path("test-images")
-	s.saveTmpImagesPath = os.Getenv("TEST_SAVE_TMP_IMAGES")
-	s.matcher = testutil.NewImageHashMatcher(s.TestData)
-
-	s.Config().Security.DefaultOptions.MaxAnimationFrames = 999
-	s.Config().Server.DevelopmentErrorsMode = true
-	s.Config().Fetcher.Transport.Local.Root = s.testImagesPath
-}
-
-// testLoadFolder fetches images iterates over images in the specified folder,
-// runs imgproxy on each image, and compares the result with the reference image
-// which is expected to be in the `integration` folder with the same name
-// but with `.png` extension.
-func (s *LoadTestSuite) testLoadFolder(folder string) {
-	walkPath := path.Join(s.testImagesPath, folder)
-
-	// Iterate over the files in the source folder
-	err := filepath.Walk(walkPath, func(path string, info os.FileInfo, err error) error {
-		s.Require().NoError(err)
-
-		// Skip directories
-		if info.IsDir() {
-			return nil
-		}
-
-		// get the base name of the file (8-bpp.png)
-		baseName := filepath.Base(path)
-
-		// Construct the source URL for imgproxy (no processing)
-		sourceUrl := fmt.Sprintf("/insecure/plain/local:///%s/%s@bmp", folder, baseName)
-
-		// Read source image from imgproxy
-		resp := s.GET(sourceUrl)
-		defer resp.Body.Close()
-
-		s.Require().Equal(http.StatusOK, resp.StatusCode, "expected status code 200 OK, got %d, path: %s", resp.StatusCode, path)
-
-		// Match image to precalculated hash
-		s.matcher.ImageMatches(s.T(), resp.Body, baseName, maxDistance)
-
-		return nil
-	})
-
-	s.Require().NoError(err)
-}
-
-// TestLoadSaveToPng ensures that our load pipeline works,
-// including standard and custom loaders. For each source image
-// in the folder, it does the passthrough request through imgproxy:
-// no processing, just convert format of the source file to png.
-// Then, it compares the result with the reference image.
-func (s *LoadTestSuite) TestLoadSaveToPng() {
-	testCases := []struct {
-		name       string
-		imageType  imagetype.Type
-		folderName string
-	}{
-		{"GIF", imagetype.GIF, "gif"},
-		{"JPEG", imagetype.JPEG, "jpg"},
-		{"HEIC", imagetype.HEIC, "heif"},
-		{"JXL", imagetype.JXL, "jxl"},
-		{"SVG", imagetype.SVG, "svg"},
-		{"TIFF", imagetype.TIFF, "tiff"},
-		{"WEBP", imagetype.WEBP, "webp"},
-		{"BMP", imagetype.BMP, "bmp"},
-		{"ICO", imagetype.ICO, "ico"},
-	}
-
-	for _, tc := range testCases {
-		s.T().Run(tc.name, func(t *testing.T) {
-			if vips.SupportsLoad(tc.imageType) {
-				s.testLoadFolder(tc.folderName)
-			} else {
-				t.Skipf("%s format not supported by VIPS", tc.name)
-			}
-		})
-	}
-}
-
-func TestIntegration(t *testing.T) {
-	suite.Run(t, new(LoadTestSuite))
-}

integration/matrix_test.go

@@ -0,0 +1,128 @@
+package integration
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+	"path"
+	"path/filepath"
+	"testing"
+
+	"github.com/imgproxy/imgproxy/v3/imagetype"
+	"github.com/imgproxy/imgproxy/v3/testutil"
+	"github.com/imgproxy/imgproxy/v3/vips"
+	"github.com/stretchr/testify/suite"
+)
+
+const (
+	// maximum Hamming distance between the source and destination hash
+	// NOTE: 2 here is because HEIC works a bit differently over the platforms, investigate
+	maxDistance = 2
+)
+
+// formats to test
+var formats = []imagetype.Type{
+	imagetype.GIF,
+	imagetype.JPEG,
+	imagetype.HEIC,
+	imagetype.JXL,
+	imagetype.SVG,
+	imagetype.TIFF,
+	imagetype.WEBP,
+	imagetype.BMP,
+	imagetype.ICO,
+}
+
+type MatrixTestSuite struct {
+	Suite
+
+	matcher        *testutil.ImageHashMatcher
+	testImagesPath string
+}
+
+func (s *MatrixTestSuite) SetupTest() {
+	s.testImagesPath = s.TestData.Path("test-images")
+	s.matcher = testutil.NewImageHashMatcher(s.TestData)
+
+	s.Config().Security.DefaultOptions.MaxAnimationFrames = 999
+	s.Config().Server.DevelopmentErrorsMode = true
+	s.Config().Fetcher.Transport.Local.Root = s.testImagesPath
+}
+
+// testLoadFolder fetches images iterates over images in the specified folder,
+// runs imgproxy on each image, and compares the result with the reference image
+// which is expected to be in the `integration` folder with the same name
+// but with `.png` extension.
+func (s *MatrixTestSuite) testFormat(source, target imagetype.Type) {
+	folder := source.String()
+
+	// TODO: rename the folders in test-images repo
+	if folder == "heic" {
+		folder = "heif"
+	}
+
+	if folder == "jpeg" {
+		folder = "jpg"
+	}
+
+	walkPath := path.Join(s.testImagesPath, folder)
+
+	// Iterate over the files in the source folder
+	err := filepath.Walk(walkPath, func(path string, info os.FileInfo, err error) error {
+		s.Require().NoError(err)
+
+		// Skip directories
+		if info.IsDir() {
+			return nil
+		}
+
+		// get the base name of the file (8-bpp.png)
+		baseName := filepath.Base(path)
+
+		// Construct the source URL for imgproxy (no processing)
+		sourceUrl := fmt.Sprintf("/insecure/plain/local:///%s/%s@%s", folder, baseName, target.String())
+
+		// Read source image from imgproxy
+		resp := s.GET(sourceUrl)
+		defer resp.Body.Close()
+
+		s.Require().Equal(http.StatusOK, resp.StatusCode, "expected status code 200 OK, got %d, url: %s", resp.StatusCode, sourceUrl)
+
+		// Match image to precalculated hash
+		s.matcher.ImageMatches(s.T(), resp.Body, baseName, maxDistance)
+
+		return nil
+	})
+
+	s.Require().NoError(err)
+}
+
+func (s *MatrixTestSuite) TestMatrix() {
+	for _, source := range formats {
+		for _, target := range formats {
+			s.Run(fmt.Sprintf("%s/%s", source.String(), target.String()), func() {
+				if !target.IsVector() && source.IsVector() {
+					// we can not vectorize a raster image
+					s.T().Logf("Skipping %s -> %s conversion: we can not vectorize raster image", source.String(), target.String())
+					return
+				}
+
+				if !vips.SupportsLoad(source) {
+					s.T().Logf("Skipping %s -> %s conversion: source format not supported by VIPS", source.String(), target.String())
+					return
+				}
+
+				if !vips.SupportsSave(target) {
+					s.T().Logf("Skipping %s -> %s conversion: target format not supported by VIPS", source.String(), target.String())
+					return
+				}
+
+				s.testFormat(source, target)
+			})
+		}
+	}
+}
+
+func TestMatrix(t *testing.T) {
+	suite.Run(t, new(MatrixTestSuite))
+}

integration/suite.go

@@ -44,26 +44,31 @@ func (s *Suite) SetupSuite() {
 	s.TestData = testutil.NewTestDataProvider(s.T)
 
 	s.Config, _ = testutil.NewLazySuiteObj(s, func() (*imgproxy.Config, error) {
-		// TODO: replace with NewDefaultConfig when we get rid of global config
-		c, err := imgproxy.LoadConfigFromEnv(nil)
-		s.Require().NoError(err)
+		c := imgproxy.NewDefaultConfig()
 
 		c.Server.Bind = ":0"
 
 		c.Fetcher.Transport.Local.Root = s.TestData.Root()
 		c.Fetcher.Transport.HTTP.ClientKeepAliveTimeout = 0
 
-		return c, nil
+		return &c, nil
 	})
 
 	s.Imgproxy, _ = testutil.NewLazySuiteObj(s, func() (*imgproxy.Imgproxy, error) {
 		return imgproxy.New(s.T().Context(), s.Config())
 	})
 
+	// NOTE: if we used s.T().Context() in startServer, server would have been stopped
+	// after the first subtest because s.T().Context() is cancelled after subtest.
+	//
+	// If resetLazyObjs is not called in SetupSubTest, the server would shutdown
+	// and won't restart in the second subtest because lazy obj would not be nil.
+	ctx := s.T().Context()
+
 	s.Server, _ = testutil.NewLazySuiteObj(
 		s,
 		func() (*TestServer, error) {
-			return s.startServer(s.Imgproxy()), nil
+			return s.startServer(ctx, s.Imgproxy()), nil
 		},
 		func(s *TestServer) error {
 			s.Shutdown()
@@ -78,8 +83,8 @@ func (s *Suite) TearDownSuite() {
 
 // startServer starts imgproxy instance's server for the tests.
 // Returns [TestServer] that contains the server address and shutdown function
-func (s *Suite) startServer(i *imgproxy.Imgproxy) *TestServer {
-	ctx, cancel := context.WithCancel(s.T().Context())
+func (s *Suite) startServer(ctx context.Context, i *imgproxy.Imgproxy) *TestServer {
+	ctx, cancel := context.WithCancel(ctx)
 
 	addrCh := make(chan net.Addr)