aglinxinyuan commented on code in PR #5739: URL: https://github.com/apache/texera/pull/5739#discussion_r3424477941
########## common/workflow-operator/src/test/scala/org/apache/texera/amber/operator/PortDescriptorSpec.scala: ########## @@ -0,0 +1,187 @@ +/* + * 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.texera.amber.operator + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties +import org.apache.texera.amber.core.workflow.UnknownPartition +import org.apache.texera.amber.util.JSONUtils.objectMapper +import org.scalatest.flatspec.AnyFlatSpec + +class PortDescriptorSpec extends AnyFlatSpec { + + // --------------------------------------------------------------------------- + // Fixtures + // --------------------------------------------------------------------------- + + // The trait is mixed-in by Jackson-deserialized descriptor classes; for + // contract testing, mix it into a plain test class. The variables are + // `var` and default to `null` by design (Jackson sets them after + // construction). + private class TestPortHolder extends PortDescriptor + + private def desc(id: String): PortDescription = + PortDescription( + portID = id, + displayName = s"display-$id", + disallowMultiInputs = false, + isDynamicPort = false, + partitionRequirement = UnknownPartition() + ) + + // --------------------------------------------------------------------------- + // PortDescriptor — defaults + mutability + // --------------------------------------------------------------------------- + + "PortDescriptor (default)" should + "leave inputPorts and outputPorts as null (Jackson sets them post-construction)" in { + val holder = new TestPortHolder + assert(holder.inputPorts == null) + assert(holder.outputPorts == null) + } + + "PortDescriptor" should "allow inputPorts to be assigned post-construction" in { + val holder = new TestPortHolder + holder.inputPorts = List(desc("a")) + assert(holder.inputPorts.size == 1) + assert(holder.inputPorts.head.portID == "a") + } + + it should "allow outputPorts to be assigned post-construction" in { + val holder = new TestPortHolder + holder.outputPorts = List(desc("o-1"), desc("o-2")) + assert(holder.outputPorts.size == 2) + assert(holder.outputPorts.map(_.portID) == List("o-1", "o-2")) + } + + // --------------------------------------------------------------------------- + // PortDescription — case-class constructor + defaults + // --------------------------------------------------------------------------- + + "PortDescription" should "preserve every field passed to the constructor" in { + val p = PortDescription( + portID = "p", + displayName = "Display", + disallowMultiInputs = true, + isDynamicPort = true, + partitionRequirement = UnknownPartition(), + dependencies = List(0, 1) + ) + assert(p.portID == "p") + assert(p.displayName == "Display") + assert(p.disallowMultiInputs) + assert(p.isDynamicPort) + assert(p.partitionRequirement == UnknownPartition()) + assert(p.dependencies == List(0, 1)) + } + + it should "default `dependencies` to `List.empty` when omitted" in { + val p = PortDescription( + portID = "p", + displayName = "d", + disallowMultiInputs = false, + isDynamicPort = false, + partitionRequirement = UnknownPartition() + ) + assert(p.dependencies == List.empty[Int]) + } + + // --------------------------------------------------------------------------- + // PortDescription — equality / copy (case-class semantics) + // --------------------------------------------------------------------------- + + "PortDescription equality" should "compare every field" in { + val a = PortDescription("p", "d", false, false, UnknownPartition()) + val b = PortDescription("p", "d", false, false, UnknownPartition()) + val c = PortDescription("OTHER", "d", false, false, UnknownPartition()) + assert(a == b) + assert(a.hashCode == b.hashCode) + assert(a != c) + } + + "PortDescription.copy" should "replace only the field supplied" in { + val base = PortDescription("p", "d", false, false, UnknownPartition()) + val updated = base.copy(displayName = "new") + assert(updated.portID == "p") + assert(updated.displayName == "new") + // Original is unchanged — immutable case-class semantics. + assert(base.displayName == "d") + } + + // --------------------------------------------------------------------------- + // Backward-compat shim — `@JsonIgnoreProperties("allowMultiInputs")` on + // PortDescription (workflows persisted before PR #4379 emitted the key + // `allowMultiInputs`; Jackson must NOT fail on unknown field). + // --------------------------------------------------------------------------- + + "PortDescription" should + "carry @JsonIgnoreProperties(\"allowMultiInputs\") (backward-compat for pre-#4379 workflows)" in { + val ann = classOf[PortDescription].getAnnotation(classOf[JsonIgnoreProperties]) + assert(ann != null, "@JsonIgnoreProperties must be present on PortDescription") + assert( + ann.value.toSet.contains("allowMultiInputs"), + s"expected 'allowMultiInputs' in @JsonIgnoreProperties value, got: ${ann.value.toList}" + ) + } + + it should + "deserialize a JSON payload that includes the legacy `allowMultiInputs` key without failing" in { + // The legacy-key tolerance is what we pin here; the `type: "none"` + // discriminator on `partitionRequirement` is `PartitionInfo`'s + // `@JsonTypeInfo` shape for `UnknownPartition`. If + // `allowMultiInputs` were missing from `@JsonIgnoreProperties`, the + // default Jackson behavior would raise `UnrecognizedPropertyException` + // here and the case would fail. + val legacyJson = """ + { + "portID": "p", + "displayName": "d", + "allowMultiInputs": true, + "disallowMultiInputs": false, + "isDynamicPort": false, + "partitionRequirement": { "type": "none" } + } Review Comment: Fixed in 22194b58e3 — added a second case "deserialize a truly-legacy payload that has `allowMultiInputs` but NO `disallowMultiInputs`" that exercises the shape of pre-#4379 workflow JSONs (only the legacy key present, no new key). Asserts Jackson tolerates the missing new field and applies the case-class default (`false`). ########## common/workflow-operator/src/test/scala/org/apache/texera/amber/operator/PortDescriptorSpec.scala: ########## @@ -0,0 +1,187 @@ +/* + * 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.texera.amber.operator + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties +import org.apache.texera.amber.core.workflow.UnknownPartition +import org.apache.texera.amber.util.JSONUtils.objectMapper +import org.scalatest.flatspec.AnyFlatSpec + +class PortDescriptorSpec extends AnyFlatSpec { + + // --------------------------------------------------------------------------- + // Fixtures + // --------------------------------------------------------------------------- + + // The trait is mixed-in by Jackson-deserialized descriptor classes; for + // contract testing, mix it into a plain test class. The variables are + // `var` and default to `null` by design (Jackson sets them after + // construction). + private class TestPortHolder extends PortDescriptor + + private def desc(id: String): PortDescription = + PortDescription( + portID = id, + displayName = s"display-$id", + disallowMultiInputs = false, + isDynamicPort = false, + partitionRequirement = UnknownPartition() + ) + + // --------------------------------------------------------------------------- + // PortDescriptor — defaults + mutability + // --------------------------------------------------------------------------- + + "PortDescriptor (default)" should + "leave inputPorts and outputPorts as null (Jackson sets them post-construction)" in { + val holder = new TestPortHolder + assert(holder.inputPorts == null) + assert(holder.outputPorts == null) + } + + "PortDescriptor" should "allow inputPorts to be assigned post-construction" in { + val holder = new TestPortHolder + holder.inputPorts = List(desc("a")) + assert(holder.inputPorts.size == 1) + assert(holder.inputPorts.head.portID == "a") + } + + it should "allow outputPorts to be assigned post-construction" in { + val holder = new TestPortHolder + holder.outputPorts = List(desc("o-1"), desc("o-2")) + assert(holder.outputPorts.size == 2) + assert(holder.outputPorts.map(_.portID) == List("o-1", "o-2")) + } + + // --------------------------------------------------------------------------- + // PortDescription — case-class constructor + defaults + // --------------------------------------------------------------------------- + + "PortDescription" should "preserve every field passed to the constructor" in { + val p = PortDescription( + portID = "p", + displayName = "Display", + disallowMultiInputs = true, + isDynamicPort = true, + partitionRequirement = UnknownPartition(), + dependencies = List(0, 1) + ) + assert(p.portID == "p") + assert(p.displayName == "Display") + assert(p.disallowMultiInputs) + assert(p.isDynamicPort) + assert(p.partitionRequirement == UnknownPartition()) + assert(p.dependencies == List(0, 1)) + } + + it should "default `dependencies` to `List.empty` when omitted" in { + val p = PortDescription( + portID = "p", + displayName = "d", + disallowMultiInputs = false, + isDynamicPort = false, + partitionRequirement = UnknownPartition() + ) + assert(p.dependencies == List.empty[Int]) + } + + // --------------------------------------------------------------------------- + // PortDescription — equality / copy (case-class semantics) + // --------------------------------------------------------------------------- + + "PortDescription equality" should "compare every field" in { + val a = PortDescription("p", "d", false, false, UnknownPartition()) + val b = PortDescription("p", "d", false, false, UnknownPartition()) + val c = PortDescription("OTHER", "d", false, false, UnknownPartition()) + assert(a == b) + assert(a.hashCode == b.hashCode) + assert(a != c) + } + + "PortDescription.copy" should "replace only the field supplied" in { + val base = PortDescription("p", "d", false, false, UnknownPartition()) + val updated = base.copy(displayName = "new") + assert(updated.portID == "p") + assert(updated.displayName == "new") + // Original is unchanged — immutable case-class semantics. + assert(base.displayName == "d") + } + + // --------------------------------------------------------------------------- + // Backward-compat shim — `@JsonIgnoreProperties("allowMultiInputs")` on + // PortDescription (workflows persisted before PR #4379 emitted the key + // `allowMultiInputs`; Jackson must NOT fail on unknown field). + // --------------------------------------------------------------------------- + + "PortDescription" should + "carry @JsonIgnoreProperties(\"allowMultiInputs\") (backward-compat for pre-#4379 workflows)" in { + val ann = classOf[PortDescription].getAnnotation(classOf[JsonIgnoreProperties]) + assert(ann != null, "@JsonIgnoreProperties must be present on PortDescription") + assert( + ann.value.toSet.contains("allowMultiInputs"), + s"expected 'allowMultiInputs' in @JsonIgnoreProperties value, got: ${ann.value.toList}" + ) + } + + it should + "deserialize a JSON payload that includes the legacy `allowMultiInputs` key without failing" in { + // The legacy-key tolerance is what we pin here; the `type: "none"` + // discriminator on `partitionRequirement` is `PartitionInfo`'s + // `@JsonTypeInfo` shape for `UnknownPartition`. If + // `allowMultiInputs` were missing from `@JsonIgnoreProperties`, the + // default Jackson behavior would raise `UnrecognizedPropertyException` + // here and the case would fail. + val legacyJson = """ + { + "portID": "p", + "displayName": "d", + "allowMultiInputs": true, + "disallowMultiInputs": false, + "isDynamicPort": false, + "partitionRequirement": { "type": "none" } + } + """ + val parsed = scala.util.Try(objectMapper.readValue(legacyJson, classOf[PortDescription])) + assert(parsed.isSuccess, s"legacy JSON must deserialize without error; got: $parsed") + } + + // --------------------------------------------------------------------------- + // JSON round-trip — every field survives serde + // --------------------------------------------------------------------------- + + "PortDescription JSON round-trip" should + "preserve portID / displayName / disallowMultiInputs / isDynamicPort / dependencies" in { + val p = PortDescription( + portID = "rt-1", + displayName = "rt-display", + disallowMultiInputs = true, + isDynamicPort = true, + partitionRequirement = UnknownPartition(), + dependencies = List(2, 3, 5) + ) + val json = objectMapper.writeValueAsString(p) + val restored = objectMapper.readValue(json, classOf[PortDescription]) + assert(restored.portID == p.portID) + assert(restored.displayName == p.displayName) + assert(restored.disallowMultiInputs == p.disallowMultiInputs) + assert(restored.isDynamicPort == p.isDynamicPort) + assert(restored.dependencies == p.dependencies) Review Comment: Fixed in 22194b58e3 — round-trip case now asserts `restored.partitionRequirement == p.partitionRequirement` (UnknownPartition); added a follow-on case that round-trips `HashPartition(List("a", "b"))` so a non-default PartitionInfo subtype + discriminator (`type` property) is exercised end-to-end. -- 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]
