Option specs and fixes

PullRequest: truffleruby/647

Author: chrisseaton

spec/tags/truffle/options/defaults_tags.txt

@@ -0,0 +1,7 @@
+slow:Options have a default
+slow:Options can be set explicitly back to their default value
+slow:Options can be set explicitly to a value
+slow:Options can be set explicitly to an implicit value
+slow:Options can be set using a simple referenced option
+slow:Options can be set using a negated referenced option
+slow:Options take an explicit value over a modified referenced option

spec/tags/truffle/options/parsing_tags.txt

@@ -0,0 +1,8 @@
+slow:Options can correctly parse booleans
+slow:Options can correctly parse integers
+slow:Options can correctly parse enum values
+slow:Options can correctly parse strings
+slow:Options can correctly parse arrays of strings
+slow:Options handles parsing errors with booleans
+slow:Options handles parsing errors with integers
+slow:Options handles parsing errors with enum values

spec/truffle/options/defaults_spec.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+require_relative '../../ruby/spec_helper'
+
+describe "Options" do
+
+  it "have a default" do
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')").should == "8\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')").should == "false\n"
+  end
+
+  it "can be set explicitly back to their default value" do
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')", options: "--dispatch.cache=8").should == "8\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--polyglot.stdio=false").should == "false\n"
+  end
+
+  it "can be set explicitly to a value" do
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')", options: "--dispatch.cache=99").should == "99\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--polyglot.stdio=true").should == "true\n"
+  end
+
+  it "can be set explicitly to an implicit value" do
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--polyglot.stdio").should == "true\n"
+  end
+
+  it "can be set using a simple referenced option" do
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')", options: "--default_cache=99").should == "99\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--embedded").should == "true\n"
+  end
+
+  it "can be set using a negated referenced option" do
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--platform.native=false").should == "true\n"
+  end
+
+  it "take an explicit value over a modified referenced option" do
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')", options: "--default_cache=101 --dispatch.cache=99").should == "99\n"
+    ruby_exe("p Truffle::Boot.get_option('dispatch.cache')", options: "--dispatch.cache=99 --default_cache=101").should == "99\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--embedded --polyglot.stdio=false").should == "false\n"
+    ruby_exe("p Truffle::Boot.get_option('polyglot.stdio')", options: "--polyglot.stdio=false --embedded").should == "false\n"
+  end
+
+end

spec/truffle/options/parsing_spec.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 1.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+require_relative '../../ruby/spec_helper'
+
+describe "Options" do
+
+  describe "can correctly parse" do
+
+    it "booleans" do
+      ruby_exe("p Truffle::Boot.get_option('frozen_string_literals')").should_not == "true\n"
+      ruby_exe("p Truffle::Boot.get_option('frozen_string_literals')", options: "--frozen_string_literals=true").should == "true\n"
+      ruby_exe("p Truffle::Boot.get_option('frozen_string_literals')", options: "--frozen_string_literals").should == "true\n"
+    end
+
+    it "integers" do
+      ruby_exe("p Truffle::Boot.get_option('default_cache')").should_not == "99\n"
+      ruby_exe("p Truffle::Boot.get_option('default_cache')", options: "--default_cache=99").should == "99\n"
+    end
+
+    it "enum values" do
+      ruby_exe("p Truffle::Boot.get_option('verbosity')").should_not == ":NIL\n"
+      ruby_exe("p Truffle::Boot.get_option('verbosity')", options: "--verbosity=NIL").should == ":NIL\n"
+    end
+
+    it "strings" do
+      ruby_exe("p Truffle::Boot.get_option('launcher')", options: "--launcher=ruby_spec_test_value").should == "\"ruby_spec_test_value\"\n"
+      ruby_exe("p Truffle::Boot.get_option('launcher')", options: "'--launcher=ruby spec test value with spaces'").should == "\"ruby spec test value with spaces\"\n"
+    end
+
+    it "arrays of strings" do
+      ruby_exe("p Truffle::Boot.get_option('load_paths')", options: "--load_paths=ruby_spec_test_value").should == "[\"ruby_spec_test_value\"]\n"
+      ruby_exe("p Truffle::Boot.get_option('load_paths')", options: "--load_paths=a,b,c").should == "[\"a\", \"b\", \"c\"]\n"
+      ruby_exe("p Truffle::Boot.get_option('load_paths')", options: "--load_paths=a\\\\,b,c").should == "[\"a,b\", \"c\"]\n"
+    end
+
+  end
+
+  describe "handles parsing errors with" do
+
+    it "booleans" do
+      ruby_exe("14", options: "--frozen_string_literals=foo", args: "2>&1").should include("Invalid boolean option value 'foo'")
+    end
+
+    it "integers" do
+      ruby_exe("14", options: "--default_cache=foo", args: "2>&1").should include("Invalid argument --default_cache=foo specified")
+    end
+
+    it "enum values" do
+      ruby_exe("14", options: "--verbosity=foo", args: "2>&1").should include("Invalid argument --verbosity=foo specified. No enum constant org.truffleruby.shared.options.Verbosity.FOO'")
+    end
+
+  end
+
+end

src/launcher/java/org/truffleruby/launcher/options/CommandLineException.java renamed to src/launcher/java/org/truffleruby/launcher/CommandLineException.java

@@ -24,7 +24,7 @@
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the EPL, the GPL or the LGPL.
  ***** END LICENSE BLOCK *****/
-package org.truffleruby.launcher.options;
+package org.truffleruby.launcher;
 
 public class CommandLineException extends Exception {
 

src/launcher/java/org/truffleruby/launcher/options/CommandLineParser.java renamed to src/launcher/java/org/truffleruby/launcher/CommandLineParser.java

@@ -32,7 +32,7 @@
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the EPL, the GPL or the LGPL.
  */
-package org.truffleruby.launcher.options;
+package org.truffleruby.launcher;
 
 import org.truffleruby.shared.options.CommandLineOptions;
 import org.truffleruby.shared.options.DefaultExecutionAction;

src/launcher/java/org/truffleruby/launcher/RubyLauncher.java

@@ -15,9 +15,7 @@
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.PolyglotException;
 import org.graalvm.polyglot.Source;
-import org.truffleruby.launcher.options.CommandLineException;
 import org.truffleruby.shared.options.CommandLineOptions;
-import org.truffleruby.launcher.options.CommandLineParser;
 import org.truffleruby.shared.options.DefaultExecutionAction;
 import org.truffleruby.shared.options.ExecutionAction;
 import org.truffleruby.shared.options.OptionsCatalog;

src/main/java/org/truffleruby/language/RubyBaseNode.java

@@ -62,6 +62,10 @@ protected DynamicObject createArray(Object store, int size) {
         return ArrayHelpers.createArray(getContext(), store, size);
     }
 
+    protected DynamicObject createArray(Object[] store) {
+        return createArray(store, store.length);
+    }
+
     protected DynamicObject createBignum(BigInteger value) {
         return BignumOperations.createBignum(getContext(), value);
     }

src/main/java/org/truffleruby/language/TruffleBootNodes.java

@@ -337,18 +337,35 @@ public abstract static class GetOptionNode extends CoreMethodArrayArgumentsNode
         @TruffleBoundary
         @Specialization(guards = "isRubyString(optionName)")
         public Object getOption(DynamicObject optionName) {
-            final OptionDescription<?> description = OptionsCatalog.fromName("ruby." + StringOperations.getString(optionName));
-            assert description != null;
+            final String optionNameString = StringOperations.getString(optionName);
+
+            final OptionDescription<?> description = OptionsCatalog.fromName("ruby." + optionNameString);
+
+            if (description == null) {
+                throw new RaiseException(getContext(), coreExceptions().nameError("option not defined", nil(), optionNameString, this));
+            }
+
             final Object value = getContext().getOptions().fromDescription(description);
 
-            if (value instanceof String) {
-                return makeStringNode.executeMake(value, UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
+            if (value instanceof Boolean || value instanceof Integer) {
+                return value;
             } else if (value instanceof Enum) {
                 return getSymbol(((Enum<?>) value).name());
+            } else if (value instanceof String) {
+                return makeStringNode.executeMake(value, UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
+            } else if (value instanceof String[]) {
+                return toRubyArray((String[]) value);
             } else {
-                assert value instanceof Integer || value instanceof Boolean;
-                return value;
+                throw new UnsupportedOperationException();
+            }
+        }
+
+        private DynamicObject toRubyArray(String[] strings) {
+            final Object[] objects = new Object[strings.length];
+            for (int n = 0; n < strings.length; n++) {
+                objects[n] = makeStringNode.executeMake(strings[n], UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
             }
+            return createArray(objects);
         }
 
     }

src/shared/java/org/truffleruby/shared/TruffleRuby.java

@@ -7,7 +7,6 @@
  * GNU General Public License version 2, or
  * GNU Lesser General Public License version 2.1.
  */
-
 package org.truffleruby.shared;
 
 import org.graalvm.polyglot.Engine;
@@ -66,7 +65,7 @@ public static String getEngineVersion() {
             return systemVersion + "-" + BuildInformationImpl.INSTANCE.getRevision();
         }
 
-
         return systemVersion;
     }
+    
 }