ganeshashree commented on code in PR #58034: URL: https://github.com/apache/spark/pull/58034#discussion_r4057447451
########## sql/core/src/test/scala/org/apache/spark/sql/JsonObjectSuite.scala: ########## @@ -0,0 +1,778 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.spark.sql + +import org.apache.spark.SparkRuntimeException +import org.apache.spark.sql.catalyst.analysis.Star +import org.apache.spark.sql.catalyst.analysis.TypeCheckResult.DataTypeMismatch +import org.apache.spark.sql.catalyst.expressions.{Cast, Collate, JsonConstructorNullBehavior, JsonObjectExpr, Literal} +import org.apache.spark.sql.catalyst.parser.ParseException +import org.apache.spark.sql.internal.SQLConf +import org.apache.spark.sql.test.SharedSparkSession +import org.apache.spark.sql.types.{CharType, GeometryType, IntegerType, MapType, StringType, VarcharType} + +/** + * End-to-end tests for the SQL:2016 `JSON_OBJECT` constructor function. + */ +class JsonObjectSuite extends QueryTest with SharedSparkSession { + import testImplicits._ + + test("basic object from key-value pairs using VALUE keyword") { + checkAnswer( + sql("SELECT json_object('id' VALUE 7, 'name' VALUE 'Ada')"), + Row("""{"id":7,"name":"Ada"}""")) + } + + test("construct object using optional KEY keyword") { + checkAnswer( + sql("SELECT json_object(KEY 'id' VALUE 7, KEY 'name' VALUE 'Ada')"), + Row("""{"id":7,"name":"Ada"}""")) + } + + test("construct object using colon syntax") { + checkAnswer( + sql("SELECT json_object('id': 7, 'name': 'Ada')"), + Row("""{"id":7,"name":"Ada"}""")) + } + + test("construct object using comma-separated key-value syntax") { + checkAnswer( + sql("SELECT json_object('id', 7, 'name', 'Ada')"), + Row("""{"id":7,"name":"Ada"}""")) + } + + test("an odd number of arguments in the comma syntax is rejected") { + // The comma form requires paired key/value arguments; a dangling key ('name') has no value. + // JSON_OBJECT is a non-reserved keyword, so when the constructor grammar cannot match, the call + // parses as an ordinary function call and routes to the registered built-in, whose builder + // rejects the odd argument count rather than silently dropping the dangling key. + val e = intercept[AnalysisException] { + sql("SELECT json_object('id', 7, 'name')") + } + assert(e.getCondition == "WRONG_NUM_ARGS.WITHOUT_SUGGESTION") + } + + test("mixing the VALUE/colon form and the comma form is a parse error") { + // The two member-list styles are mutually exclusive grammar alternatives, so a single + // constructor cannot mix `key VALUE value` (or `key : value`) members with `key, value` ones. + Seq( + "SELECT json_object('a', 1, 'b' VALUE 2)", + "SELECT json_object('a' VALUE 1, 'b', 2)", + "SELECT json_object('a' : 1, 'b', 2)").foreach { query => + intercept[ParseException](sql(query)) + } + } + + test("construct object with NULL values (default NULL ON NULL)") { + checkAnswer( + sql("SELECT json_object('id': 7, 'v': NULL)"), + Row("""{"id":7,"v":null}""")) + } + + test("construct object with explicit NULL ON NULL") { + checkAnswer( + sql("SELECT json_object('id', 7, 'v', NULL NULL ON NULL)"), + Row("""{"id":7,"v":null}""")) + } + + test("construct object with NULL values and ABSENT ON NULL") { + checkAnswer( + sql("SELECT json_object('id': 7, 'v': NULL ABSENT ON NULL)"), + Row("""{"id":7}""")) + } + + test("construct empty object") { + checkAnswer( + sql("SELECT json_object()"), + Row("{}")) + } + + test("construct object with mixed scalar types") { + checkAnswer( + sql("""SELECT json_object('int': 42, 'str': 'hello', 'bool': true, + 'float': 3.14)"""), + Row("""{"int":42,"str":"hello","bool":true,"float":3.14}""")) + } + + test("construct object with decimal type via Jackson") { + checkAnswer( + sql("""SELECT json_object('d' VALUE CAST('123.45' AS DECIMAL(5,2)))"""), + Row("""{"d":123.45}""")) + } + + test("construct object with DATE type via Jackson") { + checkAnswer( + sql("""SELECT json_object('d' VALUE DATE'2020-01-02')"""), + Row("""{"d":"2020-01-02"}""")) + } + + test("construct object with TIMESTAMP type via Jackson") { + // Note: Jackson includes timezone offset when session timezone is set + checkAnswer( + sql("""SELECT json_object('ts' VALUE TIMESTAMP'2020-01-02 10:30:00')"""), + Row("""{"ts":"2020-01-02T10:30:00.000-08:00"}""")) + } + + test("struct value renders like to_json") { + // A struct value must render exactly like `to_json` of the equivalent member. + checkAnswer( + sql("SELECT json_object('s' VALUE named_struct('a', 1, 'b', 'x'))"), + Row("""{"s":{"a":1,"b":"x"}}""")) + checkAnswer( + sql("SELECT json_object('s' VALUE named_struct('a', 1, 'b', 'x'))"), + sql("SELECT to_json(named_struct('s', named_struct('a', 1, 'b', 'x')))")) + } + + test("array value renders like to_json") { + checkAnswer( + sql("SELECT json_object('a' VALUE array(1, 2, 3))"), + Row("""{"a":[1,2,3]}""")) + checkAnswer( + sql("SELECT json_object('a' VALUE array(1, 2, 3))"), + sql("SELECT to_json(named_struct('a', array(1, 2, 3)))")) + } + + test("map value renders like to_json") { + checkAnswer( + sql("SELECT json_object('m' VALUE map('x', 1, 'y', 2))"), + Row("""{"m":{"x":1,"y":2}}""")) + checkAnswer( + sql("SELECT json_object('m' VALUE map('x', 1, 'y', 2))"), + sql("SELECT to_json(named_struct('m', map('x', 1, 'y', 2)))")) + } + + test("nested complex value combining struct, array and map renders like to_json") { + val value = "named_struct('arr', array(1, 2), 'm', map('k', named_struct('n', 3)))" + checkAnswer( + sql(s"SELECT json_object('c' VALUE $value)"), + sql(s"SELECT to_json(named_struct('c', $value))")) + } + + test("struct value honors spark.sql.jsonGenerator.ignoreNullFields like to_json") { + // `ON NULL` controls only top-level members; a null field *inside* a struct value follows + // spark.sql.jsonGenerator.ignoreNullFields, like `to_json`. + val value = "named_struct('a', 1, 'b', CAST(NULL AS INT))" + Seq("true", "false").foreach { ignore => + withSQLConf(SQLConf.JSON_GENERATOR_IGNORE_NULL_FIELDS.key -> ignore) { + checkAnswer( + sql(s"SELECT json_object('s' VALUE $value)"), + sql(s"SELECT to_json(named_struct('s', $value))")) + } + } + withSQLConf(SQLConf.JSON_GENERATOR_IGNORE_NULL_FIELDS.key -> "false") { + checkAnswer(sql(s"SELECT json_object('s' VALUE $value)"), Row("""{"s":{"a":1,"b":null}}""")) + } + withSQLConf(SQLConf.JSON_GENERATOR_IGNORE_NULL_FIELDS.key -> "true") { + checkAnswer(sql(s"SELECT json_object('s' VALUE $value)"), Row("""{"s":{"a":1}}""")) + } + } + + test("top-level ON NULL and struct-internal ignoreNullFields are independent") { + // With NULL ON NULL (default) and ignoreNullFields=true, a top-level NULL member is kept as + // `null` while a null field inside a struct value is dropped. + withSQLConf(SQLConf.JSON_GENERATOR_IGNORE_NULL_FIELDS.key -> "true") { + checkAnswer( + sql("""SELECT json_object('top' VALUE CAST(NULL AS INT), + 's' VALUE named_struct('a', 1, 'b', CAST(NULL AS INT)))"""), + Row("""{"top":null,"s":{"a":1}}""")) + } + } + + test("string escaping in keys") { + checkAnswer( + sql("""SELECT json_object('key"with"quotes' VALUE 1)"""), + Row("""{"key\"with\"quotes":1}""")) + } + + // For scalar string values JSON_OBJECT must escape exactly like to_json of the equivalent + // struct (both go through the same Jackson generator); assert that equivalence rather than + // hand-encoding the escaping, which is easy to get wrong across Scala/SQL/JSON layers. + test("string escaping in values matches to_json") { + checkAnswer( + sql("""SELECT json_object('msg' VALUE 'hello +world')"""), + sql("""SELECT to_json(named_struct('msg', 'hello +world'))""")) + } + + test("string escaping with backslash matches to_json") { + checkAnswer( + sql("""SELECT json_object('path' VALUE 'c:\windows')"""), + sql("""SELECT to_json(named_struct('path', 'c:\windows'))""")) + } + + test("nested JSON_OBJECT spliced raw") { + checkAnswer( + sql("""SELECT json_object('a' VALUE json_object('b' VALUE 1))"""), + Row("""{"a":{"b":1}}""")) + checkAnswer( + sql("""SELECT json_object('a', json_object('b', 1))"""), + Row("""{"a":{"b":1}}""")) + } + + test("nested JSON_OBJECT with multiple levels") { + checkAnswer( + sql("""SELECT json_object('outer' VALUE + json_object('inner' VALUE 42, 'name' VALUE 'test'))"""), + Row("""{"outer":{"inner":42,"name":"test"}}""")) + } + + test("a nested JSON_ARRAY value is spliced raw") { + checkAnswer( + sql("SELECT json_object('a' VALUE json_array(1, 2))"), + Row("""{"a":[1,2]}""")) + } + + test("JSON_OBJECT nested directly in JSON_ARRAY is spliced as an object element") { + // The inverse nesting direction: a JSON_OBJECT in a JSON_ARRAY element position stays on the + // direct grammar path (JsonArrayValueContext), so it is spliced as a JSON object rather than + // routed through resolution and emitted as a quoted string. + checkAnswer( + sql("SELECT json_array(json_object('a', 1), json_object('b', 2))"), + Row("""[{"a":1},{"b":2}]""")) + } + + test("a nested JSON_QUERY value is spliced under KEEP QUOTES and quoted under OMIT QUOTES") { + // JSON_QUERY emits JSON text under the default KEEP QUOTES, so a lexically nested JSON_QUERY is + // spliced raw: the matched object is {"x":1}, not the quoted string "{\"x\":1}". + checkAnswer( + sql("""SELECT json_object('a' VALUE json_query('{"o":{"x":1}}', '$.o'))"""), + Row("""{"a":{"x":1}}""")) + // OMIT QUOTES returns the matched scalar string's decoded content (Ada, not "Ada") -- an + // ordinary string -- so it takes the quoted path (emitsImplicitJsonText is false), never the + // invalid splice {"a":Ada}. + checkAnswer( + sql("""SELECT json_object('a' VALUE json_query('{"n":"Ada"}', '$.n' OMIT QUOTES))"""), + Row("""{"a":"Ada"}""")) + } + + test("null key error") { + val e = intercept[SparkRuntimeException] { + sql("SELECT json_object(NULL VALUE 'value')").collect() + } + // Assert the structured error contract, not just the message text. + assert(e.getCondition == "JSON_OBJECT_NULL_KEY") + assert(e.getSqlState == "2200E") + } + + test("a null key is validated before a null value is omitted under ABSENT ON NULL") { + // ABSENT ON NULL omits members with a null value, but the key is validated first, so a null key + // still raises JSON_OBJECT_NULL_KEY rather than being silently dropped along with the member. + val e = intercept[SparkRuntimeException] { + sql("SELECT json_object(NULL VALUE NULL ABSENT ON NULL)").collect() + } + assert(e.getCondition == "JSON_OBJECT_NULL_KEY") + assert(e.getSqlState == "2200E") + } + + test("non-foldable key and value expressions") { + val df = Seq(("key1", "val1"), ("key2", "val2")).toDF("k", "v") + checkAnswer( + df.selectExpr("json_object(k VALUE v)"), + Seq(Row("""{"key1":"val1"}"""), Row("""{"key2":"val2"}"""))) + } + + test("non-foldable with NULL value and NULL ON NULL") { + val df = Seq(("k", null), ("key", "val")).toDF("k", "v") + checkAnswer( + df.selectExpr("json_object(k VALUE v)"), + Seq(Row("""{"k":null}"""), Row("""{"key":"val"}"""))) + } + + test("non-foldable with NULL value and ABSENT ON NULL") { + val df = Seq(("k", null), ("key", "val")).toDF("k", "v") + checkAnswer( + df.selectExpr("json_object(k VALUE v ABSENT ON NULL)"), + Seq(Row("{}"), Row("""{"key":"val"}"""))) + } + + test("multiple keys with ABSENT ON NULL") { + checkAnswer( + sql("""SELECT json_object('a' VALUE 1, 'b' VALUE NULL, 'c' VALUE 3 + ABSENT ON NULL)"""), + Row("""{"a":1,"c":3}""")) + } + + test("duplicate keys are emitted in source order") { + checkAnswer( + sql("SELECT json_object('k' VALUE 1, 'k' VALUE 2)"), + Row("""{"k":1,"k":2}""")) + } + + test("non-string key type is rejected at analysis, not at execution") { + val ex = intercept[AnalysisException] { + sql("SELECT json_object(1 VALUE 'x')") + } + assert(ex.getMessage.contains("UNEXPECTED_INPUT_TYPE")) + } + + test("non-string key type reports the actual key argument") { + val ex = intercept[AnalysisException] { + sql("SELECT json_object('ok' VALUE 1, 2 VALUE 'bad')") + } + checkError( + exception = ex, + condition = "DATATYPE_MISMATCH.UNEXPECTED_INPUT_TYPE", + sqlState = Some("42K09"), + parameters = Map( + "sqlExpr" -> "\"JSON_OBJECT(ok VALUE 1, 2 VALUE bad)\"", + "paramIndex" -> "third", + "requiredType" -> "\"STRING\"", + "inputSql" -> "\"2\"", + "inputType" -> "\"INT\""), + queryContext = Array(ExpectedContext("json_object('ok' VALUE 1, 2 VALUE 'bad')", 7, 46))) + } + + test("collated STRING RETURNING is accepted") { + // isValidReturningType must accept any StringType instance, not just the default collation. + checkAnswer( + sql("SELECT json_object('a' VALUE 1 RETURNING STRING COLLATE UTF8_LCASE)"), + Row("""{"a":1}""")) + } + + test("an invalid RETURNING type is reported under DATATYPE_MISMATCH") { + // The error is emitted as a DataTypeMismatch, so its condition must resolve under + // DATATYPE_MISMATCH -- not as a top-level INVALID_JSON_RETURNING_TYPE class. + val e = intercept[AnalysisException] { + sql("SELECT json_object('a' VALUE 1 RETURNING INT)").collect() + } + assert(e.getCondition == "DATATYPE_MISMATCH.INVALID_JSON_RETURNING_TYPE") + } + + test("a directly-constructed JsonObjectExpr with a CHAR/VARCHAR RETURNING is rejected") { + // The parser normalizes CHAR/VARCHAR RETURNING to STRING, but a raw CharType/VarcharType from + // direct Catalyst construction would advertise a length JSON_OBJECT does not enforce. + Seq(VarcharType(2), CharType(2)).foreach { returning => + val expr = JsonObjectExpr( + Seq((Literal("k"), Literal(1))), Seq(false), JsonConstructorNullBehavior.Null, returning) + expr.checkInputDataTypes() match { + case DataTypeMismatch(errorSubClass, _) => + assert(errorSubClass == "INVALID_JSON_RETURNING_TYPE", s"for $returning") + case other => fail(s"expected DataTypeMismatch for $returning, got $other") + } + } + } + + test("value accepts an unparenthesized predicate expression") { + // valueExpr is parsed as a full `expression`, so ordinary predicates work without parentheses. + checkAnswer(sql("SELECT json_object('isnull' VALUE 1 IS NULL)"), Row("""{"isnull":false}""")) + checkAnswer(sql("SELECT json_object('gt' : 2 > 1)"), Row("""{"gt":true}""")) + } + + test("widening the value to expression does not change documented forms") { + // Design-doc examples where a value abuts the ON NULL / RETURNING keywords must still parse and + // evaluate identically after widening valueExpression -> expression. + checkAnswer(sql("SELECT json_object('id': 7, 'v': NULL)"), Row("""{"id":7,"v":null}""")) + checkAnswer( + sql("SELECT json_object('id': 7, 'v': NULL ABSENT ON NULL)"), Row("""{"id":7}""")) + checkAnswer( + sql("SELECT json_object('id', 7, 'v', NULL ABSENT ON NULL)"), Row("""{"id":7}""")) + checkAnswer( + sql("SELECT json_object('id' VALUE 7, 'name' VALUE 'Ada')"), + Row("""{"id":7,"name":"Ada"}""")) + } + + test("an unsupported value type is rejected at analysis") { Review Comment: Done. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
