Skip to content

Feature/checker include duplicate properties #64

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.

Sign up for GitHub

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

Open
stashjones wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feature/checker include duplicate properties #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
689dff7
Deficient model checking updated to allow data member checks
stashjones Aug 22, 2022
c037d59
Now checks for duplicate properties
stashjones Aug 22, 2022
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
32 changes: 23 additions & 9 deletions Meraki.ApiChecker/Extensions/TypeExtension.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using Meraki.Api.Attributes;
using System.Reflection;
using System.Runtime.Serialization;

namespace Meraki.ApiChecker.Extensions;
public static class TypeExtension
Expand Down Expand Up @@ -27,7 +28,7 @@ public static class TypeExtension
public static bool IsGenericList(this Type type)
=> type.IsGenericType && type.GetGenericTypeDefinition() == typeof(List<>);

public static List<string> GetDeficientDataModels(this Type type, bool isRoot = true)
public static List<string> GetDeficientDataModels(this Type type, bool isRoot = true, bool isParentClassReadOnly = false)
{
// If we're at the root and this is a generic list then deal with the underlying generic type
// as attributes won't be assigned to the generic list
Expand All @@ -43,23 +44,36 @@ public static List<string> GetDeficientDataModels(this Type type, bool isRoot =
return new();
}

if (type.GetCustomAttribute<ApiAccessReadOnlyClassAttribute>() is not null)
{
// It's a read-only class, so return here
return new List<string>();
}
var isClassReadOnly = isParentClassReadOnly || type.GetCustomAttribute<ApiAccessReadOnlyClassAttribute>() is not null;

var deficientDataModels = new List<string>();
var dataMemberNames = new Dictionary<string, string>();

foreach (var property in type.GetProperties())
{
var dataMemberAttribute = property.GetCustomAttribute<DataMemberAttribute>();
if (dataMemberAttribute != null)
{
var dataMemberName = dataMemberAttribute.Name ?? "Not set";
if (dataMemberNames.TryGetValue(dataMemberName, out var existingPropertyName))
{
deficientDataModels.Add($"Found {existingPropertyName} already has DataMemberName '{dataMemberName}' when processing {property.Name} property on {type}");
}
else
{
dataMemberNames[dataMemberName] = property.Name;
}
}

// Is ApiAccessAttribute or ApiKeyAttribute present on the property?
if (property.GetCustomAttribute<ApiAccessAttribute>() is null
if (!isClassReadOnly
&& property.GetCustomAttribute<ApiAccessAttribute>() is null
&& property.GetCustomAttribute<ApiKeyAttribute>() is null)
{
// NO - ApiAccess is not fully denoted for the type
if (!deficientDataModels.Contains(type.Name))
{
deficientDataModels.Add(type.Name);
deficientDataModels.Add($"{type.Name} is missing ApiAccessAttribute");
}
}

Expand All @@ -68,7 +82,7 @@ public static List<string> GetDeficientDataModels(this Type type, bool isRoot =
// Is it a class? AND ensure it's a class we didn't discover yet
if (propertyType?.IsClass == true && !deficientDataModels.Contains(propertyType.Name))
{
deficientDataModels.AddRange(GetDeficientDataModels(propertyType, false));
deficientDataModels.AddRange(GetDeficientDataModels(propertyType, false, isClassReadOnly));
}
}

Expand Down