private static FieldName parseFieldName(com.palantir.conjure.parser.types.names.FieldName parserFieldName) { FieldName fieldName = FieldName.of(parserFieldName.name()); FieldNameValidator.validate(fieldName); return fieldName; }
/** Converts this {@link FieldName} to a {@link FieldName} with the given case. */ public static FieldName toCase(FieldName fieldName, CaseConverter.Case targetCase) { return FieldName.of(nameCase(fieldName).convertTo(fieldName.get(), targetCase)); }
@Test public void testValidNames() { FieldNameValidator.validate(FieldName.of("camel")); FieldNameValidator.validate(FieldName.of("camelCase")); FieldNameValidator.validate(FieldName.of("camelCase1")); FieldNameValidator.validate(FieldName.of("camel1Case2")); FieldNameValidator.validate(FieldName.of("kebab-case")); FieldNameValidator.validate(FieldName.of("kebab1-case123")); FieldNameValidator.validate(FieldName.of("snake_case")); FieldNameValidator.validate(FieldName.of("snake1_case123")); FieldNameValidator.validate(FieldName.of("xCoordinate")); FieldNameValidator.validate(FieldName.of("defaultXPosition")); FieldNameValidator.validate(FieldName.of("defaultX")); }
@Test public void capitalize_should_turn_camel_case_into_sensible_class_name() throws Exception { assertThat(FieldNameValidator.capitalize(FieldName.of("myVariant"))).isEqualTo("MyVariant"); }
@Test public void testInvalidNames() throws Exception { for (String invalid : new String[] { "UpperCamelCase", "Upper-Kebab-Case", "Upper_Snake_Case", "ABC", "$special", "special%", "snake_123_case", "kebab-123-case", "mixed-kebab_snake-case", "x", "defaultDNSName" }) { assertThatThrownBy(() -> FieldNameValidator.validate(FieldName.of(invalid))) .isInstanceOf(IllegalArgumentException.class) .hasMessageContaining(String.format( "FieldName \"%s\" must follow one of the following patterns", invalid)); } }
@Test public void testNoSelfRecursiveType() { ConjureDefinition conjureDef = ConjureDefinition.builder() .version(1) .types(ImmutableList.of(TypeDefinition.object( ObjectDefinition.builder() .typeName(FOO) .fields(FieldDefinition.of(FieldName.of("self"), Type.reference(FOO), DOCS)) .build()))) .build(); assertThatThrownBy(() -> ConjureDefinitionValidator.NO_RECURSIVE_TYPES.validate(conjureDef)) .isInstanceOf(IllegalStateException.class) .hasMessage("Illegal recursive data type: Foo -> Foo"); }
private void testUniqueFieldNameValidator(String fieldName1, String fieldName2) { FieldDefinition field1 = FieldDefinition.builder() .fieldName(FieldName.of(fieldName1)) .type(Type.primitive(PrimitiveType.STRING)) .build(); FieldDefinition field2 = FieldDefinition.builder() .fieldName(FieldName.of(fieldName2)) .type(Type.primitive(PrimitiveType.STRING)) .build(); TypeName name = TypeName.of("Foo", "package"); ObjectDefinition definition = ObjectDefinition.builder() .typeName(name) .fields(field1) .fields(field2) .build(); assertThatThrownBy(() -> ObjectDefinitionValidator.validate(definition)) .isInstanceOf(IllegalArgumentException.class) .hasMessage(String.format("ObjectDefinition must not contain duplicate field names " + "(modulo case normalization): %s vs %s", fieldName2, fieldName1)); } }
@Test public void testUnionMemberKeyMustNotBeIllegalJavaIdentifier() { ImmutableList.of("%foo", "foo@").forEach(key -> { FieldDefinition fieldDefinition = FieldDefinition.builder() .fieldName(FieldName.of(key)) .type(Type.primitive(PrimitiveType.STRING)) .build(); assertThatThrownBy(() -> UnionDefinitionValidator.validateAll(UnionDefinition.builder() .union(fieldDefinition) .typeName(TypeName.of("string", "")) .build())) .isInstanceOf(IllegalArgumentException.class) .hasMessageStartingWith( String.format("Union member key must be a valid Java identifier: %s", key)); }); }
@Test public void testRecursiveTypeOkInReference() { Type referenceType = Type.reference(FOO); TypeDefinition objectDefinition = TypeDefinition.object( ObjectDefinition.builder() .typeName(TypeName.of("Foo", "bar")) .addAllFields(ImmutableList.of( FieldDefinition.of(FieldName.of("selfOptional"), Type.optional(OptionalType.of(Type.reference(FOO))), DOCS), FieldDefinition.of(FieldName.of("selfMap"), Type.map(MapType.of(referenceType, referenceType)), DOCS), FieldDefinition.of(FieldName.of("selfSet"), Type.set(SetType.of(referenceType)), DOCS), FieldDefinition.of(FieldName.of("selfList"), Type.list(ListType.of(referenceType)), DOCS))) .build()); ConjureDefinition conjureDef = ConjureDefinition.builder() .version(1) .types(ImmutableList.of(objectDefinition)) .build(); ConjureDefinitionValidator.NO_RECURSIVE_TYPES.validate(conjureDef); }
@Test public void testNoComplexKeysInMaps() { String illegalFieldName = "asdf"; Type complexKeyType = Type.list(ListType.of(Type.primitive(PrimitiveType.STRING))); FieldDefinition fieldDefinition = FieldDefinition.of( FieldName.of(illegalFieldName), Type.map(MapType.of(complexKeyType, Type.primitive(PrimitiveType.STRING))), Documentation.of("docs")); assertThatThrownBy(() -> FieldDefinitionValidator.validate(fieldDefinition)) .isInstanceOf(IllegalStateException.class) .hasMessageContaining(illegalFieldName) .hasMessageContaining(complexKeyType.toString()); } }
@Test public void testNoRecursiveCycleType() { ConjureDefinition conjureDef = ConjureDefinition.builder() .version(1) .types(ImmutableList.of( TypeDefinition.object( ObjectDefinition.builder() .typeName(FOO) .fields(field(FieldName.of("bar"), "Bar")) .build()), TypeDefinition.object( ObjectDefinition.builder() .typeName(BAR) .fields(field(FieldName.of("foo"), "Foo")) .build()))) .build(); assertThatThrownBy(() -> ConjureDefinitionValidator.NO_RECURSIVE_TYPES.validate(conjureDef)) .isInstanceOf(IllegalStateException.class) .hasMessageStartingWith("Illegal recursive data type: "); }
@Test public void testUnionMemberKeyMustNotBeEmpty() { FieldDefinition fieldDefinition = FieldDefinition.builder() .fieldName(FieldName.of("")) .type(Type.primitive(PrimitiveType.STRING)) .build(); assertThatThrownBy(() -> UnionDefinitionValidator.validateAll(UnionDefinition.builder() .union(fieldDefinition) .typeName(TypeName.of("string", "")) .build())) .isInstanceOf(IllegalArgumentException.class) .hasMessageStartingWith("Union member key must not be empty"); }
@Test public void testUnionMemberKeyMustNotHaveTrailingUnderscore() { FieldDefinition fieldDefinition = FieldDefinition.builder() .fieldName(FieldName.of("foo_")) .type(Type.primitive(PrimitiveType.STRING)) .build(); assertThatThrownBy(() -> UnionDefinitionValidator.validateAll(UnionDefinition.builder() .union(fieldDefinition) .typeName(TypeName.of("string", "")) .build())) .isInstanceOf(IllegalArgumentException.class) .hasMessageStartingWith("Union member key must not end with an underscore: foo_"); } }
@Test public void testUniqueArgNamesValidator() { FieldDefinition safeArg1 = FieldDefinition.builder() .fieldName(FieldName.of("fooBar")) .type(Type.primitive(PrimitiveType.STRING)) .build(); FieldDefinition unsafeArg1 = FieldDefinition.builder() .fieldName(FieldName.of("foo-bar")) .type(Type.primitive(PrimitiveType.STRING)) .build(); .fieldName(FieldName.of("foo-bar")) .type(Type.primitive(PrimitiveType.STRING)) .build(); FieldDefinition unsafeArg2 = FieldDefinition.builder() .fieldName(FieldName.of("foo_bar")) .type(Type.primitive(PrimitiveType.STRING)) .build();