Script to download all GMEs

and a bit more files for the test suite

Author: nomeata

default.nix

@@ -193,10 +193,10 @@ in rec {
   gme-downloads = pkgs.runCommandNoCC "gme-downloads" {
     buildInputs = with pkgs; [ wget ];
     outputHashMode = "recursive";
-    outputHash =  "sha256:01byby8fmqmxfg5cb5ss0pmhvf2av65sil9cqbjswky0a1mn7kp5";
+    outputHash =  "sha256:02cayz36ajaw8lv2kri54vmd6qid5w4vn4s6dmagq583f887b03l";
   } ''
     mkdir -p $out
-    bash ${./testsuite/download.sh} $out
+    bash ${./testsuite/download.sh} ${./testsuite/gme-files-test.txt} $out
   '';
 
   tests = pkgs.stdenv.mkDerivation {

testsuite/.gitignore

@@ -1,3 +1,5 @@
 output
 ./downloaded
+./all-gmes
 !expected/**
+

testsuite/README.md

@@ -1,7 +1,11 @@
 A small test suite for tttool
+-----------------------------
 
-The script `download.sh` downloads a few GME files into the directory
-`downloaded/`
+The script `download.sh` downloads a those GME files listed in
+`gme-files-test.txt` into the directory `downloaded/`. This is a subset of
+Ravensburger GMEs, useful for testing.
+
+Feel free to propose a different set of GME files to include in the test
 
 The script `test.sh` runs a bunch of `tttool` commands on the files in `input/`
 and `downloaded/`, putting the result in `output/`
@@ -24,3 +28,15 @@ To run the test suite with nix, run
 If the downloaded files changed, change the `outputHash` in
 `../default.nix` a bit, run the above, and then copy the new hash from the
 error message into the `.nix` file.
+
+
+Getting more GMEs
+-----------------
+
+To test theories or search for certain things, it might be useful to fetch all
+GMEs. For that, run
+
+     ./list-gmes.sh
+     ./download.sh gme-files-all.txt all-gmes
+
+Warning, this downloads ~6GB.

testsuite/download.sh

@@ -1,19 +1,11 @@
 #!/usr/bin/env bash
 
 set -e
-dir="${1:-downloaded}"
+gmes="${1:-gme-files-test.txt}"
+dir="${2:-downloaded}"
 
 mkdir -p "$dir"
-cd "$dir"
-
-# We used to have a script that would fetch an .xml file from ravensburger
-# that lists all GME files, but that XML file disappeared.
-# For now, just list some GME files
-
-function get() {
-  wget --no-verbose --timestamping --no-check-certificate \
-    https://ssl-static.ravensburger.de/db/applications/"$1"
-}
-
-get WissenQuizzen1.gme
-get Pocketwissen_Feuerwehr.gme
+while read -r filename; do
+  wget --no-verbose --timestamping --no-check-certificate -P "$dir" \
+    https://ssl-static.ravensburger.de/db/applications/"$filename"
+done < "$gmes"

testsuite/expected/downloaded/Alle meine Tiere.gme.info.txt

@@ -0,0 +1,15 @@
+Product ID: 100
+Raw XOR value: 0x000000C6
+Magic XOR value: 0x55
+Comment: CHOMPTECH DATA FORMAT CopyRight 2009 Ver2.10.0901
+Date: 20170315
+Language: 
+Number of registers: 3
+Initial registers: [0,0,0]
+Initial sounds: [[18,25]]
+Scripts for OIDs from 4201 to 4282; 0/82 are disabled.
+Audio table entries: 1086
+Binary tables entries: 0/0/0
+Single binary table entries: 1/1/1
+Special OIDs: 4210, 0
+Checksum found 0x6E379441, calculated 0x6E379441

testsuite/expected/downloaded/Alle meine Tiere.gme.lint.txt

@@ -0,0 +1 @@
+0fd54c3bbb1a88b494972a2547b08f9f  output/downloaded/Alle meine Tiere.gme.yaml

testsuite/expected/downloaded/Alle meine Tiere.gme.yaml.md5sum

@@ -0,0 +1,16 @@
+Product ID: 61
+Raw XOR value: 0x000000FA
+Magic XOR value: 0x16
+Comment: CHOMPTECH DATA FORMAT CopyRight 2009 Ver2.10.0901
+Date: 20141021
+Language: 
+Number of registers: 71
+Initial registers: [1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
+Initial sounds: [[1447,317],[317]]
+Scripts for OIDs from 5670 to 9969; 3709/4300 are disabled.
+Audio table entries: 1448
+Audio table repeated twice
+Binary tables entries: 1/1/1
+Single binary table entries: 1/1/1
+Special OIDs: 9756, 0
+Checksum found 0x0092FB3D, calculated 0x0092FB3D

testsuite/expected/downloaded/Dein Koerper und Du.gme.info.txt

@@ -0,0 +1 @@
+e2f933effc132ed235888e4f0bf22e8f  output/downloaded/Dein Koerper und Du.gme.yaml