Add GameType filter, and add ForgeAPI Verify Files to validate Mod Downloads (#1337)

Co-authored-by: christopher blodgett <christopher.blodgett@gmail.com>

tests/setuponlytests/forgeapimods_file/docker-compose.yml

@@ -7,12 +7,20 @@ services:
     environment:
       EULA: "TRUE"
       SETUP_ONLY: "TRUE"
+      # Using custom to bypass Fabric setup
+      TYPE: CUSTOM
+      # Using family to test FORGEAPI Family filter.
+      FAMILY: FABRIC
+      CUSTOM_SERVER: /servers/fake.jar
       VERSION: ${MINECRAFT_VERSION:-LATEST}
       MODS_FORGEAPI_FILE: /config/forgeapi_mods.json
       # Key is defined in .github/workflows/pr.yml and ci.yml
       # This should be coming from github secrets.
       MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}
       REMOVE_OLD_FORGEAPI_MODS: "TRUE"
-      MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "FALSE"
+      # Validates that Fabric API gets download as a dependency.
+      MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "TRUE"
     volumes:
       - ./forgeapi_mods.json:/config/forgeapi_mods.json:ro
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/forgeapimods_file/forgeapi_mods.json

@@ -1,17 +1,11 @@
 [{
-        "name": "fabric api",
-        "projectId": "306612",
+        "name": "On A Stick [FABRIC]",
+        "projectId": "550544",
         "releaseType": "release"
     },
     {
         "name": "Fabric Voice Mod",
         "projectId": "416089",
         "releaseType": "beta"
-    },
-    {
-        "name": "Biomes o plenty",
-        "projectId": "220318",
-        "fileName": "BiomesOPlenty-1.18.1-15.0.0.100-universal.jar",
-        "releaseType": "release"
     }
-]
+]

tests/setuponlytests/forgeapimods_file/verify.sh

@@ -0,0 +1,5 @@
+# Validates specific beta call out for specific mod:
+mc-image-helper assert fileExists "/data/mods/voicechat-fabric*"
+mc-image-helper assert fileExists "/data/mods/onastick-fabric*"
+# Dependent of on a stick:
+mc-image-helper assert fileExists "/data/mods/fabric-api*"

tests/setuponlytests/forgeapimods_gametype/docker-compose.yml

@@ -0,0 +1,29 @@
+version: "3"
+
+services:
+  mc:
+    restart: "no"
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "TRUE"
+      SETUP_ONLY: "TRUE"
+      # Using custom to bypass Fabric setup
+      TYPE: CUSTOM
+      # Using family to test FORGEAPI Family filter.
+      FAMILY: FABRIC
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: ${MINECRAFT_VERSION:-LATEST}
+      # Validate Skip Gametype Filter:
+      MODS_FORGEAPI_IGNORE_GAMETYPE: "TRUE"
+      # Validates that Biomes does not download terrablender
+      # Using default false for testing: 
+      # MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "FALSE"
+      # Contains mix of Forge and Fabric mods
+      MODS_FORGEAPI_PROJECTIDS: 306612,416089,220318
+      # Allows for Beta releases of 416089 the Fabric Voice Mod 
+      MODS_FORGEAPI_RELEASES: BETA
+      MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}
+      REMOVE_OLD_FORGEAPI_MODS: "FALSE"
+    volumes:
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/forgeapimods_gametype/require.sh

@@ -0,0 +1 @@
+[[ $MODS_FORGEAPI_KEY ]] || exit 1

tests/setuponlytests/forgeapimods_gametype/verify.sh

@@ -0,0 +1,5 @@
+mc-image-helper assert fileExists "/data/mods/BiomesOPlenty*"
+# testing dependencies don't get downloaded when download dependencies is set to false.
+! mc-image-helper assert fileExists "/data/mods/TerraBlender*"
+mc-image-helper assert fileExists "/data/mods/voicechat-fabric*"
+mc-image-helper assert fileExists "/data/mods/fabric-api*"

tests/setuponlytests/forgeapimods_projectids/docker-compose.yml

@@ -7,10 +7,20 @@ services:
     environment:
       EULA: "TRUE"
       SETUP_ONLY: "TRUE"
+      # Using custom to bypass Fabric setup
+      TYPE: CUSTOM
+      # Validate Skip Gametype Filter for vanilla 
+      #  - Currently we do not support filtering on vanilla.
+      FAMILY: VANILLA
+      CUSTOM_SERVER: /servers/fake.jar
       VERSION: ${MINECRAFT_VERSION:-LATEST}
       MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "TRUE"
+      # Contains mix of Forge and Fabric mods
       MODS_FORGEAPI_PROJECTIDS: 306612,416089,220318
       # Allows for Beta releases of 416089 the Fabric Voice Mod 
       MODS_FORGEAPI_RELEASES: BETA
       MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}
       REMOVE_OLD_FORGEAPI_MODS: "TRUE"
+    volumes:
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/forgeapimods_projectids/verify.sh

@@ -0,0 +1,4 @@
+mc-image-helper assert fileExists "/data/mods/BiomesOPlenty*"
+mc-image-helper assert fileExists "/data/mods/TerraBlender*"
+mc-image-helper assert fileExists "/data/mods/voicechat-fabric*"
+mc-image-helper assert fileExists "/data/mods/fabric-api*"