Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes renaming of enum options in dotnet #2874

Merged
merged 6 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Kiota.Builder/Refiners/JavaRefiner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
"set",
string.Empty
);
ReplaceReservedNames(generatedCode, reservedNamesProvider, x => $"{x}Escaped");
ReplaceReservedNames(generatedCode, reservedNamesProvider, x => $"{x}Escaped", new HashSet<Type>{typeof(CodeEnumOption)});
ReplaceReservedExceptionPropertyNames(generatedCode, new JavaExceptionsReservedNamesProvider(), x => $"{x}Escaped");
LowerCaseNamespaceNames(generatedCode);
AddPropertiesAndMethodTypesImports(generatedCode, true, false, true);
Expand Down
2 changes: 1 addition & 1 deletion src/Kiota.Builder/Refiners/PhpRefiner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
ConvertUnionTypesToWrapper(generatedCode,
_configuration.UsesBackingStore,
false);
ReplaceReservedNames(generatedCode, new PhpReservedNamesProvider(), reservedWord => $"Escaped{reservedWord.ToFirstCharacterUpperCase()}");
ReplaceReservedNames(generatedCode, new PhpReservedNamesProvider(), reservedWord => $"Escaped{reservedWord.ToFirstCharacterUpperCase()}", new HashSet<Type>{typeof(CodeEnumOption)});
AddQueryParameterFactoryMethod(generatedCode);
CorrectCoreType(generatedCode, CorrectMethodType, CorrectPropertyType, CorrectImplements);
AddParsableImplementsForModelClasses(generatedCode, "Parsable");
Expand Down
15 changes: 15 additions & 0 deletions tests/Kiota.Builder.Tests/Refiners/GoLanguageRefinerTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ public async Task AddsInnerClasses()
await ILanguageRefiner.Refine(new GenerationConfiguration { Language = GenerationLanguage.Go }, root);
Assert.Equal(2, model.GetChildElements(true).Count());
}
[Theory(Skip = "Fixing this test is a breaking change - https://github.com/microsoft/kiota/issues/2877")]
[InlineData("break")]
[InlineData("case")]
public async Task EnumWithReservedName_IsNotRenamed(string input)
{
var model = root.AddEnum(new CodeEnum
{
Name = "someenum"
}).First();
var option = new CodeEnumOption { Name = input, SerializationName = input };
model.AddOption(option);
await ILanguageRefiner.Refine(new GenerationConfiguration { Language = GenerationLanguage.Go }, root);

Assert.Equal(input, model.Options.First().Name);
}
[Fact]
public async Task TrimsCircularDiscriminatorReferences()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class JavaLanguageRefinerTests
private readonly CodeNamespace root = CodeNamespace.InitRootNamespace();
#region CommonLanguageRefinerTests
[Fact]
public async Task ReplacesReservedEnumOptions()
public async Task DoesNotReplacesReservedEnumOptions()
{
var model = root.AddEnum(new CodeEnum
{
Expand All @@ -25,8 +25,8 @@ public async Task ReplacesReservedEnumOptions()
};
model.AddOption(option);
await ILanguageRefiner.Refine(new GenerationConfiguration { Language = GenerationLanguage.Java }, root);
Assert.Equal("breakEscaped", option.Name);
Assert.Equal("break", option.SerializationName);
Assert.Equal("break", option.Name);
Assert.Equal("", option.SerializationName);
baywet marked this conversation as resolved.
Show resolved Hide resolved
}
[Fact]
public async Task AddsExceptionInheritanceOnErrorClasses()
Expand Down
16 changes: 16 additions & 0 deletions tests/Kiota.Builder.Tests/Refiners/PhpLanguageRefinerTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,22 @@ public async Task ReplacesRequestBuilderPropertiesByMethods()
Assert.Equal("userRequestBuilder", model.Name);
}

[Theory]
[InlineData("break")]
[InlineData("case")]
public async Task EnumWithReservedName_IsNotRenamed(string input)
{
var model = root.AddEnum(new CodeEnum
{
Name = "someenum"
}).First();
var option = new CodeEnumOption { Name = input, SerializationName = input };
model.AddOption(option);
await ILanguageRefiner.Refine(new GenerationConfiguration { Language = GenerationLanguage.PHP }, root);

Assert.Equal(input, model.Options.First().Name);
}

[Fact]
public async Task PrefixReservedWordPropertyNamesWith()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,21 @@ public async Task AddsQueryParameterMapperMethodAfterMangling()
Assert.Single(model.Properties.Where(x => x.IsNameEscaped));
Assert.Single(model.Methods.Where(x => x.IsOfKind(CodeMethodKind.QueryParametersMapper)));
}
[Theory]
[InlineData("None")]
[InlineData("while")]
public async Task EnumWithReservedName_IsRenamed(string input)
{
var model = root.AddEnum(new CodeEnum
{
Name = "someenum"
}).First();
var option = new CodeEnumOption { Name = input, SerializationName = input };
model.AddOption(option);
await ILanguageRefiner.Refine(new GenerationConfiguration { Language = GenerationLanguage.Python }, root);

Assert.Equal(input+"_", model.Options.First().Name);// we need to escape this in python
}
[Fact]
public async Task AddsExceptionInheritanceOnErrorClasses()
{
Expand Down