Rename tools (#123)

Author: paulthomson

docs/development.md

@@ -312,7 +312,7 @@ manager.queueCommand?
 manager.queueCommand(
   "ReduceVariant for xxx",
   [
-    "reduce_variant",
+    "glsl-reduce",
     "--reference", "processing/7093366951813584254/test_exp/recipient.info.json",
     "--reduce_everywhere",
     "--output", "processing/7093366951813584254/test_variant_1_inv",

python/src/main/python/drivers/generate_shader_families python/src/main/python/drivers/glsl-generate

@@ -16,4 +16,4 @@
 @REM  limitations under the License.
 @REM
 
-python "%~dp0reduce.py" %*
+python "%~dpn0.py" %*

python/src/main/python/drivers/reduce.bat python/src/main/python/drivers/glsl-generate.bat

@@ -16,4 +16,4 @@
 @REM  limitations under the License.
 @REM
 
-python "%~dp0generate_shader_families.py" %*
+python "%~dpn0.py" %*

python/src/main/python/drivers/generate_shader_families.py python/src/main/python/drivers/glsl-generate.py

@@ -58,19 +58,24 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class Reduce {
+public class GlslReduce {
 
-  private static final Logger LOGGER = LoggerFactory.getLogger(Reduce.class);
+  private static final Logger LOGGER = LoggerFactory.getLogger(GlslReduce.class);
 
   private static ArgumentParser getParser() {
 
-    ArgumentParser parser = ArgumentParsers.newArgumentParser("Reduce")
-          .defaultHelp(true)
-          .description("Reduce a shader job, driven by a criterion of interest.");
+    ArgumentParser parser = ArgumentParsers.newArgumentParser("glsl-reduce")
+        .defaultHelp(true)
+        .description("Reduce GLSL shaders, driven by a criterion of interest. "
+            + "The tool takes a \"shader job\" as input, "
+            + "which is a set of files with the same name (e.g. NAME) in the same directory, "
+            + "including NAME.json (a metadata file that can be empty) "
+            + "and some graphics shaders (NAME.frag and/or NAME.vert) "
+            + "or a compute shader (NAME.comp).");
 
     // Required arguments
     parser.addArgument("shader_job")
-          .help("Path of shader job to be reduced.  E.g. /path/to/variant.json ")
+          .help("Path of shader job to be reduced.  E.g. /path/to/shaderjob.json ")
           .type(File.class);
 
     parser.addArgument("reduction_kind")

python/src/main/python/drivers/reduce python/src/main/python/drivers/glsl-reduce

@@ -16,7 +16,6 @@
 
 package com.graphicsfuzz.reducer.tool;
 
-import com.graphicsfuzz.common.glslversion.ShadingLanguageVersion;
 import com.graphicsfuzz.common.util.CompareAsts;
 import com.graphicsfuzz.common.util.ParseHelper;
 import com.graphicsfuzz.common.util.ParseTimeoutException;
@@ -30,15 +29,15 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
-public class ReduceTest {
+public class GlslReduceTest {
 
   @Rule
   public TemporaryFolder temporaryFolder = new TemporaryFolder();
 
   @Test
   public void noServerAllowedInCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{"--server", "some_server", "--token", "some_token",
+      GlslReduce.mainHelper(new String[]{"--server", "some_server", "--token", "some_token",
               makeShaderJobAndReturnJsonFilename(), "CUSTOM", "--output",
               temporaryFolder.getRoot().getAbsolutePath()}
           , null);
@@ -51,7 +50,7 @@ public void noServerAllowedInCustomReduction() throws Exception {
   @Test
   public void noTokenAllowedInCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{"--token", "some_token",
+      GlslReduce.mainHelper(new String[]{"--token", "some_token",
           makeShaderJobAndReturnJsonFilename(), "CUSTOM", "--output",
           temporaryFolder.getRoot().getAbsolutePath()}, null);
       assertTrue(false);
@@ -63,7 +62,7 @@ public void noTokenAllowedInCustomReduction() throws Exception {
   @Test
   public void noErrorStringAllowedInCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{"--error_string", "some_string",
+      GlslReduce.mainHelper(new String[]{"--error_string", "some_string",
           makeShaderJobAndReturnJsonFilename(), "CUSTOM", "--output",
           temporaryFolder.getRoot().getAbsolutePath()}, null);
       assertTrue(false);
@@ -75,7 +74,7 @@ public void noErrorStringAllowedInCustomReduction() throws Exception {
   @Test
   public void noReferenceAllowedInCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{"--reference", "reference.info.json",
+      GlslReduce.mainHelper(new String[]{"--reference", "reference.info.json",
           makeShaderJobAndReturnJsonFilename(),
           "CUSTOM", "--output", temporaryFolder.getRoot().getAbsolutePath()}, null);
       assertTrue(false);
@@ -91,7 +90,7 @@ private void checkOptionNotAllowed(RuntimeException exception, String option) {
   @Test
   public void noCustomJudgeAllowedInNonCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{makeShaderJobAndReturnJsonFilename(), "NO_IMAGE",
+      GlslReduce.mainHelper(new String[]{makeShaderJobAndReturnJsonFilename(), "NO_IMAGE",
           "--custom_judge", "somejudgescript", "--output",
               temporaryFolder.getRoot().getAbsolutePath()},
           null);
@@ -105,7 +104,7 @@ public void noCustomJudgeAllowedInNonCustomReduction() throws Exception {
   @Test
   public void customJudgeRequiredInCustomReduction() throws Exception {
     try {
-      Reduce.mainHelper(new String[]{makeShaderJobAndReturnJsonFilename(), "CUSTOM", "--output",
+      GlslReduce.mainHelper(new String[]{makeShaderJobAndReturnJsonFilename(), "CUSTOM", "--output",
           temporaryFolder.getRoot().getAbsolutePath()}, null);
       assertTrue(false);
     } catch (RuntimeException exception) {
@@ -120,7 +119,7 @@ public void checkCustomJudgeIsExecutable() throws Exception {
     final File jsonFile = getShaderJobReady();
     final File emptyFile = temporaryFolder.newFile(); // Not executable
     try {
-      Reduce.mainHelper(new String[]{
+      GlslReduce.mainHelper(new String[]{
           jsonFile.getAbsolutePath(),
           "CUSTOM",
           "--custom_judge",
@@ -139,7 +138,7 @@ public void testAlwaysReduceJudgeMaximallyReduces() throws Exception {
     final File jsonFile = getShaderJobReady();
     final File emptyFile = temporaryFolder.newFile();
     emptyFile.setExecutable(true);
-    Reduce.mainHelper(new String[]{
+    GlslReduce.mainHelper(new String[]{
         jsonFile.getAbsolutePath(),
         "CUSTOM",
         "--custom_judge",

python/src/main/python/drivers/generate_shader_families.bat python/src/main/python/drivers/glsl-reduce.bat

@@ -17,7 +17,7 @@
 package com.graphicsfuzz.server;
 
 import com.graphicsfuzz.common.util.ParseTimeoutException;
-import com.graphicsfuzz.reducer.tool.Reduce;
+import com.graphicsfuzz.reducer.tool.GlslReduce;
 import com.graphicsfuzz.server.thrift.FuzzerServiceManager.Iface;
 import com.graphicsfuzz.shadersets.RunShaderFamily;
 import com.graphicsfuzz.shadersets.ShaderDispatchException;
@@ -38,8 +38,8 @@ public void dispatchCommand(List<String> command, Iface fuzzerServiceManager)
               fuzzerServiceManager
         );
         break;
-      case "reduce":
-        Reduce.mainHelper(
+      case "glsl-reduce":
+        GlslReduce.mainHelper(
               command.subList(1, command.size()).toArray(new String[0]),
               fuzzerServiceManager
         );

python/src/main/python/drivers/reduce.py python/src/main/python/drivers/glsl-reduce.py

@@ -1339,7 +1339,7 @@ private void reduce(HttpServletRequest request, HttpServletResponse response)
     response.setContentType("text/html");
 
     final List<String> args = new ArrayList<>();
-    args.add("reduce");
+    args.add("glsl-reduce");
     final String shaderJobFilePath = request.getParameter("shader_path");
     args.add(shaderJobFilePath);
     final String reductionType = request.getParameter("reduction_type");
@@ -1440,7 +1440,7 @@ private void reduceReference(String shaderJobFilePath, String worker) {
         new File(WebUiConstants.WORKER_DIR + "/" + worker + "/" + shaderset + "_exp",
               "reference.info.json");
     List<String> args = new ArrayList<>();
-    args.add("reduce");
+    args.add("glsl-reduce");
     args.add(referenceShaderJobFile.getPath());
     args.add("IDENTICAL");
     args.add("--output");

reducer/src/main/java/com/graphicsfuzz/reducer/tool/Reduce.java reducer/src/main/java/com/graphicsfuzz/reducer/tool/GlslReduce.java

@@ -26,6 +26,7 @@
 import com.graphicsfuzz.common.ast.expr.VariableIdentifierExpr;
 import com.graphicsfuzz.common.glslversion.ShadingLanguageVersion;
 import com.graphicsfuzz.common.tool.PrettyPrinterVisitor;
+import com.graphicsfuzz.reducer.tool.GlslReduce;
 import com.graphicsfuzz.util.Constants;
 import com.graphicsfuzz.common.transformreduce.GlslShaderJob;
 import com.graphicsfuzz.common.transformreduce.ShaderJob;
@@ -60,7 +61,6 @@
 import com.graphicsfuzz.reducer.reductionopportunities.ReductionOpportunities;
 import com.graphicsfuzz.reducer.reductionopportunities.ReducerContext;
 import com.graphicsfuzz.reducer.tool.RandomFileJudge;
-import com.graphicsfuzz.reducer.tool.Reduce;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
@@ -425,7 +425,7 @@ public void testBasicReduction() throws Exception {
 
     int numSteps = 20;
 
-    Reduce.mainHelper(new String[] {
+    GlslReduce.mainHelper(new String[] {
           referenceJson.getAbsolutePath(),
           "--swiftshader",
           "IDENTICAL",
@@ -442,7 +442,7 @@ public void testBasicReduction() throws Exception {
 
     while (new File(output, Constants.REDUCTION_INCOMPLETE).exists()) {
       numSteps += 5;
-      Reduce.mainHelper(new String[] {
+      GlslReduce.mainHelper(new String[] {
             referenceJson.getAbsolutePath(),
             "--swiftshader",
             "IDENTICAL",
@@ -481,7 +481,7 @@ public void testConditionForContinuingReduction() throws Exception {
     final File output = temporaryFolder.newFolder();
     // This should throw a FileNotFoundException, because REDUCTION_INCOMPLETE
     // will not be present.
-    Reduce.mainHelper(new String[] { "--swiftshader", "--continue_previous_reduction",
+    GlslReduce.mainHelper(new String[] { "--swiftshader", "--continue_previous_reduction",
           json.getAbsolutePath(), "--output",
           output.getAbsolutePath(), "NO_IMAGE" }, null);
   }
@@ -505,7 +505,7 @@ public void checkReductionIsFinite() throws Exception {
           reference, referenceImage, false);
     assertEquals(0, referenceResult.res);
     final File output = temporaryFolder.newFolder();
-    Reduce.mainHelper(new String[] {
+    GlslReduce.mainHelper(new String[] {
           referenceJson.getAbsolutePath(),
           "--swiftshader",
           "IDENTICAL",