Add script for running the validator (KhronosGroup#496)

* Add script for validating models

* Validator results are save as raw .log files and a summary README

* Remove the validatedAt property from the validator output, to reduce diff noise

* Add launch configuration for validating models

* Add documentation on validating models

Author: stevk

.gitignore

@@ -14,4 +14,4 @@
 /Source/UpgradeLog.htm
 /tempImages
 /ScreenshotGenerator
-/package-lock.json
+/Tools/node_modules

.vscode/launch.json

@@ -23,6 +23,12 @@
             "type": "coreclr",
             "request": "attach",
             "processId": "${command:pickProcess}"
+        },
+        {
+            "name": "Validate Models",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceFolder}/Tools/validate.js",
         }
     ]
-}
+}

CONTRIBUTING.md

@@ -1,36 +1,41 @@
-# Contributing to the glTF Asset Generator 
+# Contributing to the glTF Asset Generator
+
+## Dependencies
+1. Install [Visual Studio Code.](https://code.visualstudio.com/Download) (VS Code)
+2. Install the extension [C# for VS Code (powered by OmniSharp)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp).
+3. Install [npm.](https://www.npmjs.com/get-npm)
 
 ## Set Up
-1. Use `git clone https://github.com/KhronosGroup/glTF-Asset-Generator.git` to download the repro.
-2. [Install and launch VS Code.](https://code.visualstudio.com/Download)
-3. Open the local copy of the repro in VS Code.
-    1. Select `Explorer` from the sidebar.
-    2. Select `Open Folder`.
-    3. Select the location of the `glTF-Asset-Generator` folder.
-4. Install the extension [C# for VS Code (powered by OmniSharp)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp). There will likely be a popup prompt to take this action.
-    1. After installation, either relaunch VS Code or reload the extension. 
+1. Download the repro.
+    1. `git clone https://github.com/KhronosGroup/glTF-Asset-Generator.git`
+2. Run `npm install` from the [Tools](Tools) folder.
+3. Launch VS Code.
+    1. Open the local copy of the repro in VS Code.
+    2. Select `Explorer` from the sidebar.
+    3. Select `Open Folder`.
+    4. Select the location of the [glTF-Asset-Generator](https://github.com/KhronosGroup/glTF-Asset-Generator) folder.
 5. Press F5 or select `Start Debugging` from the debug menu.
 
 ## Best Practices
-+ Write readable code. 
++ Write readable code.
   + Developers that encounter issues with the models generated by this code will want to look into the code to see how that model is put together.
   + By default, add properties instead of removing properties when creating a model to reduce code complexity.
 
 + Aim to have fewer than thirteen rows and fewer than seven columns in the model group's readme table (not counting headers).
   + Each model added creates another row. Having too many rows in a table makes it difficult to read due to needing scrolling too much to view the entire model group's readme. Consider splitting the model group into two or more that are closely related.
   + Each property being tested adds another column, and usually adds another model as well. Having too many columns results in results in github's markdown squishing the table to make everything fit.
 
-+ Clearly identify models that are designed to fail to load. (Negative tests) 
-  + A client that is conformant with the glTF 2.0 spec is expected to successfully render any model created by the glTF Asset Generator, unless explicitly noted otherwise. 
++ Clearly identify models that are designed to fail to load. (Negative tests)
+  + A client that is conformant with the glTF 2.0 spec is expected to successfully render any model created by the glTF Asset Generator, unless explicitly noted otherwise.
   + If a model (or entire group of models) are not expected to load on a conformant client, then the model(s) must be marked as such in the readme.
   + Models that are not valid need the `Valid` bool set to false, even if they are not necessarily expected to fail to load. See "Flag Model as Not Valid" in [Adding Models Advanced](Documents/Adding_Models_Advanced.md).
 
 ## Common Errors
-+ The error message `Configured debug type 'coreclr'` is encountered when debugging in VS Code 
++ The error message `Configured debug type 'coreclr'` is encountered when debugging in VS Code
   + This is caused by debugging without [C# for VS Code (powered by OmniSharp)](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp) being correctly installed and loaded.
   + Be sure to reload the extension after installing it, or relaunching VS Code.
 + Error message encountered while debugging `Unhandled Exception: System.UnauthorizedAccessException: Access to the path is denied.`
-  + A file could not be overwritten. 
+  + A file could not be overwritten.
   + Check that the file isn't open in another program and that it isn't set to readonly.
 + Error message encountered while debugging `An unhandled exception of type 'System.IO.IOException' occurred in System.IO.FileSystem.dll: 'The requested operation cannot be performed on a file with a user-mapped section open'`
     + Encountered when running the debugger again too quickly after having just run it.

Documentation/Adding_Models.md

@@ -1,9 +1,10 @@
 # Creating a New Model Group
 1. [Create a Model Group Readme Template in Markdown.](#create-a-model-group-readme-template-in-markdown)
 2. [Create a New Model Group Class.](#create-a-new-model-group-class)
-3. Delete undesired models and screenshots from the local [Output](../Output) folder. (Files will be overwritten, but not deleted) 
+3. Delete undesired models and screenshots from the local [Output](../Output) folder. (Files will be overwritten, but not deleted)
 4. Compile and run the build.
-5. [Generate Screenshots.](#generate-screenshots)
+5. [Validate Models](#validate-models)
+6. [Generate Screenshots.](#generate-screenshots)
 
 ## Create a Model Group Readme Template in Markdown
 Every model group will generate a readme. The code starts with a template specific to that model group, then inserts a generated table based on the models created.
@@ -15,7 +16,7 @@ Every model group will generate a readme. The code starts with a template specif
 
 ### Readme Tips
 + Models will be listed in the readme in the order they are created in code.
-+ Property names and values as listed in the readme are formatted by the [ReadmeStringHelper](../Source/ReadmeStringHelper.cs) class, which adds spaces, fixes capitalization, and converts values into strings. 
++ Property names and values as listed in the readme are formatted by the [ReadmeStringHelper](../Source/ReadmeStringHelper.cs) class, which adds spaces, fixes capitalization, and converts values into strings.
 + Use `":white_check_mark:"` :white_check_mark: to show that something is enabled or has a positive result. Use `":x:"` :x: to show something is disabled or has a negative result.
 + When including images in a table, use a thumbnail that is the size the image is expected to be viewed at, and link it to a full-size image. This avoids issues with images being stretched.
 
@@ -26,10 +27,10 @@ These models are intended to test...
 The following table shows the properties that are set for every model.  
 
 ~~HeaderTable~~
- 
-The following table shows the properties that are set for a given model.  
 
-~~Table~~ 
+The following table shows the properties that are set for a given model.
+
+~~Table~~
 ```
 
 ### Figures
@@ -44,25 +45,25 @@ Use images to better explain how a model is setup. This is especially useful for
 3. Declare the images as being used in a model group.
     + At the top of the model group class that will be using this image, add `UseFigure(imageList, "IMAGEFILENAME");`
 4. Insert the image into the readme template.
-    + This can be done with either markdown or HTML formatting.
+    + This can be done with either markdown or HTML formatting.  
 `![alt-text](Figures/IMAGEFILENAME.png)`  
 `<img src="Figures/IMAGEFILENAME.png">`
 
 Be careful of adding images that are too large to a model group's readme, as this can cause weird spacing issues with markdown tables.
-+ Clamp the size of the image to keep the image from changing cell widths and heights too much 
++ Clamp the size of the image to keep the image from changing cell widths and heights too much.  
 `<img src="Figures/BigImage.png" width="144" height="144" align="middle">`
 
 ## Create a New Model Group Class
 1. Create a copy of the [ModelGroup_Template](../Source/Resources/Templates/ModelGroup_Template.cs) and place it under the [ModelGroups](../Source/ModelGroups) folder.
 2. Name the Class and .cs file as appropriate for what is being tested. For related model groups, use a CATEGORY_NAME format.
 3. Add the name of the model group to the `ModelGroupId` enum in [ModelGroup](../Source/ModelGroup.cs) (in alphabetical order). Then in the new class set the `Id` as that enum.
-4. Call the class from [Program](../Source/Program.cs). This is done by creating an instance of the class to add to the `allModelGroups` list (in alphabetical order). 
-5. Add code to the new model group. Add new values to the `PropertyName` enum in `Property.cs` as needed. 
+4. Call the class from [Program](../Source/Program.cs). This is done by creating an instance of the class to add to the `allModelGroups` list (in alphabetical order).
+5. Add code to the new model group. Add new values to the `PropertyName` enum in `Property.cs` as needed.
 
 ### Structure of a Model Group
 Declare the following values at the beginning of the constructor
 + Add the figures being used to the `UseFigure` list (See [Figures](#figures) above)
-+ Declare the textures being used and add them to the `UseTexture` list. 
++ Declare the textures being used and add them to the `UseTexture` list.  
 `var TextureImage = UseTexture(imageList, "FILENAME")`
 + Declare camera position(s) if a custom one will be used.
 + Declare property values that will be used in more than one model. Add properties used by every model to the `CommonProperties` list.
@@ -75,19 +76,19 @@ Assemble the model in the `CreateModel` function.
 + Call `setProperties`, which will set the desired test values on the component model objects.
 + Assemble and return the model, creating a new `Model` object using the component model objects.
 
-Add helper functions that reduce duplicate code below `CreateModel`. 
+Add helper functions that reduce duplicate code below `CreateModel`.
 + Generally, this is where the properties list is populated, which is used in creating the model group readme (See [Properties](#properties) below)
 + These functions should be specific to the one model group.
 
 Create the anonymous methods
-Inside of the code block `this.Models = new List<Model>` is where the values for each specific model will be set.
+Inside of the code block `this.Models = new List<Model>` is where the values for each specific model will be set.  
 If no values are set on a model, leave a comment to show that was intentional.
 ```C#
 CreateModel((properties, meshPrimitive) => {
 	// There are no properties set on this model.
 }),
 ```
-Otherwise, modify the component model objects that were passed in with the desired test values.
+Otherwise, modify the component model objects that were passed in with the desired test values.  
 Be careful to only modify the objects and not replace them! If the object is set equal to a new object, then the ref will point at a new object instead of updating the desired object. Instead only modify values of the object, or work with lists of objects.
 
 At the bottom of the model group `GenerateUsedPropertiesList()` is called. This is used in creating the model group readme and won't need to be modified.
@@ -99,22 +100,27 @@ At the bottom of the model group `GenerateUsedPropertiesList()` is called. This
 
 ## Generate Screenshots
 1. Download the [screenshotGenerator](https://github.com/kcoley/screenshotGenerator)
-  + Follow the directions in that repro's readme on how to build the generator.
-  + Place the folder containing the Screenshot Generator inside of the local glTF-Asset-Generator directory `.\glTF-Asset-Generator\ScreenshotGenerator\`
+    + Follow the directions in that repro's readme on how to build the generator.
+    + Place the folder containing the Screenshot Generator inside of the local glTF-Asset-Generator directory `.\glTF-Asset-Generator\ScreenshotGenerator\`
 2. Run the PowerShell script [SampleImageHelper.ps1](../SampleImageHelper.ps1)
 
-Screenshots are generated in a step separately from running the glTF Asset Generator, which also includes the moving of textures and figures into the output folders.
+Screenshots are generated in a step separately from running the glTF Asset Generator, which also includes the moving of textures and figures into the output folders.  
 This is done to speed up debugging. The creation of screenshots is a time intensive process and often the screenshots are not needed until the majority of debugging has been completed.
 
+## Validate Models
+Run the `Validate Models` VS Code launch configuration in order to use the [glTF-Validator](https://github.com/KhronosGroup/glTF-Validator) to validate the generated models. The results are saved under in the  [ValidatorResults folder](../ValidatorResults).  
+This script can also be run directly from the [Tools](../Tools) folder with the command `npm run validate`.
+New and modified models are expected to have been validated before being checked in.
+
 ## Properties
 Properties are attributes that can be set on a model. For example, Doublesided is a property and it can have a value of true or false.
 
-For each tested property that is set on a model, a [Property](../Source/Property.cs) object needs to be created. 
+For each tested property that is set on a model, a [Property](../Source/Property.cs) object needs to be created.
 ```C#
 properties.Add(new Property(PropertyName.PROPERTYNAME, PROPERTYVALUE));
 ```
-The enum will be the name of a column on the readme. The value will be displayed in that column.
-Readme columns are ordered based on the int value for `PropertyName` enums in the [Property](../Source/Property.cs) class.
+The enum will be the name of a column on the readme. The value will be displayed in that column.  
+Readme columns are ordered based on the int value for `PropertyName` enums in the [Property](../Source/Property.cs) class.  
 If having a property name doesn't make sense, use `Description` as the enum and use an explanatory string as the value.
 
 ## Runtime Layer

Source/Program.cs

@@ -109,7 +109,7 @@ private static void Main(string[] args)
                 }
             }
 
-            // Write out the master manifest JSON containing all of the model groups
+            // Write out the master manifest JSON containing all of the model groups.
             using (var writeManifest = new StreamWriter(Path.Combine(outputFolder, "Manifest.json")))
             {
                 jsonSerializer.Serialize(writeManifest, manifestMaster.ToArray());

Tools/package-lock.json

@@ -0,0 +1,8 @@
+{
+  "scripts": {
+    "validate": "node validate.js"
+  },
+  "dependencies": {
+    "gltf-validator": "^2.0.0-dev.2.7"
+  }
+}