Merge pull request #63 from Jon-Becker/jon-becker/float-validation

fix(validation): ensure values, filename, and weights are consistent

.github/workflows/tests-merged.yaml

@@ -3,6 +3,8 @@ name: Unit Tests (on PR)
 on:
   push:
     branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
 
 permissions:
   contents: read

src/common/validate.py

@@ -121,6 +121,19 @@ def validate_config(config: dict) -> bool:
                             )
                         )
 
+        # ensure each layer["values"] has a corresponding layer["filename"] and layer["weights"]
+        if len(layer["values"]) != len(layer["filename"]) or len(
+            layer["values"]
+        ) != len(layer["weights"]):
+            raise ConfigValidationError(
+                'config["layers"][{}]: The number of values, filenames, and weights must be the same. Current values: {}, filenames: {}, weights: {}'.format(
+                    i,
+                    len(layer["values"]),
+                    len(layer["filename"]),
+                    len(layer["weights"]),
+                )
+            )
+
     # check the incompatibilities and their config values
     for i, incompatibility in enumerate(config["incompatibilities"]):
         # check if all required incompatibility keys are present

src/core/main.py

@@ -20,7 +20,9 @@ def __init__(self, **args):
             if not args["config"]:
                 raise ValueError("No configuration file was provided.")
             elif not args["config"].endswith(".json"):
-                raise ValueError("Invalid configuration file '{}'".format(args["config"]))
+                raise ValueError(
+                    "Invalid configuration file '{}'".format(args["config"])
+                )
 
             if not args["amount"]:
                 raise ValueError("No amount was provided.")
@@ -40,7 +42,7 @@ def __init__(self, **args):
         self.seed = (
             int(args["seed"])
             if args["seed"] is not None
-            else int.from_bytes(random.randbytes(16), byteorder='little')
+            else int.from_bytes(random.randbytes(16), byteorder="little")
         )
         self.start_at = int(args["start_at"])
         self.output = args["output"]
@@ -124,30 +126,36 @@ def __build_genome_image(self, metadata: dict):
         Builds the NFT image for a single NFT.
         """
         layers = []
-        for index, attr in enumerate(metadata["attributes"]):
-            # get the image for the trait
-            for i, trait in enumerate(self.config["layers"][index]["values"]):
-                if trait == attr["value"]:
-                    layers.append(
-                        Image.open(
-                            f'{self.config["layers"][index]["trait_path"]}/{self.config["layers"][index]["filename"][i]}.png'
-                        ).convert("RGBA")
-                    )
-                    break
-
-        if len(layers) == 1:
-            rgb_im = layers[0].convert("RGBA")
-        elif len(layers) == 2:
-            main_composite = Image.alpha_composite(layers[0], layers[1])
-            rgb_im = main_composite.convert("RGBA")
-        elif len(layers) >= 3:
-            main_composite = Image.alpha_composite(layers[0], layers[1])
-            for index, remaining in enumerate(layers):
-                main_composite = Image.alpha_composite(main_composite, remaining)
-            rgb_im = main_composite.convert("RGBA")
-
-        # create folder structure if it doesn't exist
-        rgb_im.save("{}/images/{}.png".format(self.output, metadata["token_id"]))
+        try:
+            for index, attr in enumerate(metadata["attributes"]):
+                # get the image for the trait
+                for i, trait in enumerate(self.config["layers"][index]["values"]):
+                    if trait == attr["value"]:
+                        layers.append(
+                            Image.open(
+                                f'{self.config["layers"][index]["trait_path"]}/{self.config["layers"][index]["filename"][i]}.png'
+                            ).convert("RGBA")
+                        )
+                        break
+
+            if len(layers) == 1:
+                rgb_im = layers[0].convert("RGBA")
+            elif len(layers) == 2:
+                main_composite = Image.alpha_composite(layers[0], layers[1])
+                rgb_im = main_composite.convert("RGBA")
+            elif len(layers) >= 3:
+                main_composite = Image.alpha_composite(layers[0], layers[1])
+                for index, remaining in enumerate(layers):
+                    main_composite = Image.alpha_composite(main_composite, remaining)
+                rgb_im = main_composite.convert("RGBA")
+
+            # create folder structure if it doesn't exist
+            rgb_im.save("{}/images/{}.png".format(self.output, metadata["token_id"]))
+
+        except Exception as e:
+            self.logger.error(
+                "Error generating image for token %d: %s", metadata["token_id"], e
+            )
 
     def generate(self):
         """

tests/test_validate_config.py

@@ -45,6 +45,66 @@ def test_validate_config_missing_key():
         validate_config(config)
 
 
+def test_validate_config_layer_mismatch_weights():
+    config = {
+        "layers": [
+            {
+                "name": "Background",
+                "values": ["Python Logo", "some other value"],
+                "trait_path": "./trait-layers/foreground",
+                "filename": ["logo", "some file"],
+                "weights": [100],
+            }
+        ],
+        "baseURI": ".",
+        "name": "NFT #",
+        "description": "This is a description for this NFT series.",
+    }
+
+    with pytest.raises(ConfigValidationError):
+        validate_config(config)
+
+
+def test_validate_config_layer_mismatch_filename():
+    config = {
+        "layers": [
+            {
+                "name": "Background",
+                "values": ["Python Logo", "some other value"],
+                "trait_path": "./trait-layers/foreground",
+                "filename": ["logo"],
+                "weights": [100, 100],
+            }
+        ],
+        "baseURI": ".",
+        "name": "NFT #",
+        "description": "This is a description for this NFT series.",
+    }
+
+    with pytest.raises(ConfigValidationError):
+        validate_config(config)
+
+
+def test_validate_config_layer_mismatch_values():
+    config = {
+        "layers": [
+            {
+                "name": "Background",
+                "values": ["Python Logo"],
+                "trait_path": "./trait-layers/foreground",
+                "filename": ["logo", "logo 2"],
+                "weights": [100, 100],
+            }
+        ],
+        "baseURI": ".",
+        "name": "NFT #",
+        "description": "This is a description for this NFT series.",
+    }
+
+    with pytest.raises(ConfigValidationError):
+        validate_config(config)
+
+
 def test_validate_config_incorrect_type():
     config = {
         "layers": "should be a list",