public static async Task <int> RepoExpand(DirectoryInfo localRepo)
{
if (localRepo == null)
{
localRepo = new DirectoryInfo(Path.GetFullPath("."));
}
var repoProvider = new RepoProvider(localRepo.FullName);
if (!localRepo.Exists)
{
Outputs.WriteError($"Invalid target repository directory: {localRepo.FullName}.");
return(ReturnCodes.InvalidArguments);
}
foreach (string file in Directory.EnumerateFiles(localRepo.FullName, "*.json",
new EnumerationOptions {
RecurseSubdirectories = true
}))
{
if (file.ToLower().EndsWith(".expanded.json"))
{
continue;
}
try
{
var modelFile = new FileInfo(file);
string dtmi = ParsingUtils.GetRootId(modelFile);
if (string.IsNullOrEmpty(dtmi))
{
continue;
}
List <string> expandedModel = await repoProvider.ExpandModel(dtmi);
string formattedJson = Outputs.FormatExpandedListAsJson(expandedModel);
string createPath = DtmiConventions.GetModelUri(dtmi, new Uri(localRepo.FullName), true).AbsolutePath;
Outputs.WriteToFile(createPath, formattedJson);
Outputs.WriteOut($"Created: {createPath}");
}
catch (Exception e)
{
Outputs.WriteError($"Failure expanding model file: {file}, {e.Message}");
return(ReturnCodes.ProcessingError);
}
}
return(ReturnCodes.Success);
}
public static List <string> EnsureSubDtmiNamespace(string fileText)
{
List <string> badIds = new List <string>();
string dtmiNamespace = GetDtmiNamespace(ParsingUtils.GetRootId(fileText));
FindAllIds(fileText, (id) =>
{
if (!id.StartsWith(dtmiNamespace))
{
badIds.Add(id);
}
});
return(badIds);
}
public static void Import(string modelContent, DirectoryInfo repository)
{
string rootId = ParsingUtils.GetRootId(modelContent);
string createPath = DtmiConventions.GetModelUri(rootId, new Uri(repository.FullName)).AbsolutePath;
Outputs.WriteOut($"- Importing model \"{rootId}\"...");
if (File.Exists(createPath))
{
Outputs.WriteOut(
$"- Skipping \"{rootId}\". Model file already exists in repository.",
ConsoleColor.DarkCyan);
return;
}
(new FileInfo(createPath)).Directory.Create();
Outputs.WriteToFile(createPath, modelContent);
}
public static string EnsureValidModelFilePath(string modelFilePath, string modelContent, string repository)
{
if (RepoProvider.IsRelativePath(repository))
{
repository = Path.GetFullPath(repository);
}
string rootId = ParsingUtils.GetRootId(modelContent);
Uri targetModelPathUri = DtmiConventions.GetModelUri(rootId, new Uri(repository));
Uri modelFilePathUri = new Uri(modelFilePath);
if (targetModelPathUri.AbsolutePath != modelFilePathUri.AbsolutePath)
{
return(Path.GetFullPath(targetModelPathUri.AbsolutePath));
}
return(null);
}
public static async Task <int> Export(string dtmi, FileInfo modelFile, string repo, FileInfo outputFile)
{
// Check that we have either model file or dtmi
if (string.IsNullOrWhiteSpace(dtmi) && modelFile == null)
{
string invalidArgMsg = "Please specify a value for --dtmi";
Outputs.WriteError(invalidArgMsg);
return(ReturnCodes.InvalidArguments);
}
var repoProvider = new RepoProvider(repo);
try
{
if (string.IsNullOrWhiteSpace(dtmi))
{
dtmi = ParsingUtils.GetRootId(modelFile);
if (string.IsNullOrWhiteSpace(dtmi))
{
Outputs.WriteError("Model is missing root @id");
return(ReturnCodes.ValidationError);
}
}
List <string> expandedModel = await repoProvider.ExpandModel(dtmi);
string formattedJson = Outputs.FormatExpandedListAsJson(expandedModel);
Outputs.WriteOut(formattedJson);
Outputs.WriteToFile(outputFile, formattedJson);
}
catch (RequestFailedException requestEx)
{
Outputs.WriteError(requestEx.Message);
return(ReturnCodes.ResolutionError);
}
catch (System.Text.Json.JsonException jsonEx)
{
Outputs.WriteError($"Parsing json-ld content. Details: {jsonEx.Message}");
return(ReturnCodes.InvalidArguments);
}
return(ReturnCodes.Success);
}
public static async Task <int> Validate(FileInfo modelFile, string repo, bool strict)
{
try
{
RepoProvider repoProvider = new RepoProvider(repo);
FileExtractResult extractResult = ParsingUtils.ExtractModels(modelFile);
List <string> models = extractResult.Models;
if (models.Count == 0)
{
Outputs.WriteError("No models to validate.");
return(ReturnCodes.InvalidArguments);
}
ModelParser parser;
if (models.Count > 1)
{
// Special case: when validating from an array, only use array contents for resolution.
// Setup vanilla parser with no resolution. We get a better error message when a delegate is assigned.
parser = new ModelParser
{
DtmiResolver = (IReadOnlyCollection <Dtmi> dtmis) =>
{
return(Task.FromResult(Enumerable.Empty <string>()));
}
};
}
else
{
parser = repoProvider.GetDtdlParser();
}
Outputs.WriteOut($"- Validating models conform to DTDL...");
await parser.ParseAsync(models);
if (strict)
{
if (extractResult.ContentKind == JsonValueKind.Array || models.Count > 1)
{
// Related to file path validation.
Outputs.WriteError("Strict validation requires a single root model object.");
return(ReturnCodes.ValidationError);
}
string dtmi = ParsingUtils.GetRootId(models[0]);
Outputs.WriteOut($"- Ensuring DTMIs namespace conformance for model \"{dtmi}\"...");
List <string> invalidSubDtmis = Validations.EnsureSubDtmiNamespace(models[0]);
if (invalidSubDtmis.Count > 0)
{
Outputs.WriteError(
$"The following DTMI's do not start with the root DTMI namespace:{Environment.NewLine}{string.Join($",{Environment.NewLine}", invalidSubDtmis)}");
return(ReturnCodes.ValidationError);
}
// TODO: Evaluate changing how file path validation is invoked.
if (RepoProvider.IsRemoteEndpoint(repo))
{
Outputs.WriteError($"Model file path validation requires a local repository.");
return(ReturnCodes.ValidationError);
}
Outputs.WriteOut($"- Ensuring model file path adheres to DMR path conventions...");
string filePathError = Validations.EnsureValidModelFilePath(modelFile.FullName, models[0], repo);
if (filePathError != null)
{
Outputs.WriteError(
$"File \"{modelFile.FullName}\" does not adhere to DMR path conventions. Expecting \"{filePathError}\".");
return(ReturnCodes.ValidationError);
}
}
}
catch (ResolutionException resolutionEx)
{
Outputs.WriteError(resolutionEx.Message);
return(ReturnCodes.ResolutionError);
}
catch (RequestFailedException requestEx)
{
Outputs.WriteError(requestEx.Message);
return(ReturnCodes.ResolutionError);
}
catch (ParsingException parsingEx)
{
IList <ParsingError> errors = parsingEx.Errors;
string normalizedErrors = string.Empty;
foreach (ParsingError error in errors)
{
normalizedErrors += $"{Environment.NewLine}{error.Message}";
}
Outputs.WriteError(normalizedErrors);
return(ReturnCodes.ValidationError);
}
catch (IOException ioEx)
{
Outputs.WriteError(ioEx.Message);
return(ReturnCodes.InvalidArguments);
}
catch (ArgumentException argEx)
{
Outputs.WriteError(argEx.Message);
return(ReturnCodes.InvalidArguments);
}
catch (System.Text.Json.JsonException jsonEx)
{
Outputs.WriteError($"Parsing json-ld content. Details: {jsonEx.Message}");
return(ReturnCodes.InvalidArguments);
}
return(ReturnCodes.Success);
}
public static int RepoIndex(DirectoryInfo localRepo, FileInfo outputFile, int pageLimit)
{
if (localRepo == null)
{
localRepo = new DirectoryInfo(Path.GetFullPath("."));
}
if (!localRepo.Exists)
{
Outputs.WriteError($"Invalid target repository directory: {localRepo.FullName}.");
return(ReturnCodes.InvalidArguments);
}
int currentPageCount = 0;
int pageIdentifier = 1;
FileInfo currentPageFile = outputFile;
var modelDictionary = new ModelDictionary();
var currentLinks = new ModelIndexLinks
{
Self = currentPageFile.FullName
};
foreach (string file in Directory.EnumerateFiles(localRepo.FullName, "*.json",
new EnumerationOptions {
RecurseSubdirectories = true
}))
{
if (file.ToLower().EndsWith(".expanded.json"))
{
continue;
}
// TODO: Debug plumbing.
// Outputs.WriteDebug($"Processing: {file}");
try
{
var modelFile = new FileInfo(file);
ModelIndexEntry indexEntry = ParsingUtils.ParseModelFileForIndex(modelFile);
modelDictionary.Add(indexEntry.Dtmi, indexEntry);
currentPageCount += 1;
if (currentPageCount == pageLimit)
{
var nextPageFile = new FileInfo(
Path.Combine(
currentPageFile.Directory.FullName,
$"index.page.{pageIdentifier}.json"));
currentLinks.Next = nextPageFile.FullName;
var nextLinks = new ModelIndexLinks
{
Self = nextPageFile.FullName,
Prev = currentLinks.Self
};
var modelIndex = new ModelIndex(modelDictionary, currentLinks);
IndexPageUtils.WritePage(modelIndex);
currentPageCount -= pageLimit;
modelDictionary = new ModelDictionary();
currentPageFile = nextPageFile;
currentLinks = nextLinks;
pageIdentifier += 1;
}
}
catch (Exception e)
{
Outputs.WriteError($"Failure processing model file: {file}, {e.Message}");
return(ReturnCodes.ProcessingError);
}
}
if (modelDictionary.Count > 0)
{
var modelIndex = new ModelIndex(modelDictionary, currentLinks);
IndexPageUtils.WritePage(modelIndex);
}
return(ReturnCodes.Success);
}
public static async Task <int> Import(FileInfo modelFile, DirectoryInfo localRepo, bool strict)
{
if (localRepo == null)
{
localRepo = new DirectoryInfo(Path.GetFullPath("."));
}
try
{
RepoProvider repoProvider = new RepoProvider(localRepo.FullName);
FileExtractResult extractResult = ParsingUtils.ExtractModels(modelFile);
List <string> models = extractResult.Models;
if (models.Count == 0)
{
Outputs.WriteError("No models to import.");
return(ReturnCodes.ValidationError);
}
Outputs.WriteOut($"- Validating models conform to DTDL...");
ModelParser parser = repoProvider.GetDtdlParser();
await parser.ParseAsync(models);
if (strict)
{
foreach (string content in models)
{
string dtmi = ParsingUtils.GetRootId(content);
Outputs.WriteOut($"- Ensuring DTMIs namespace conformance for model \"{dtmi}\"...");
List <string> invalidSubDtmis = Validations.EnsureSubDtmiNamespace(content);
if (invalidSubDtmis.Count > 0)
{
Outputs.WriteError(
$"The following DTMI's do not start with the root DTMI namespace:{Environment.NewLine}{string.Join($",{Environment.NewLine}", invalidSubDtmis)}");
return(ReturnCodes.ValidationError);
}
}
}
foreach (string content in models)
{
ModelImporter.Import(content, localRepo);
}
}
catch (ResolutionException resolutionEx)
{
Outputs.WriteError(resolutionEx.Message);
return(ReturnCodes.ResolutionError);
}
catch (RequestFailedException requestEx)
{
Outputs.WriteError(requestEx.Message);
return(ReturnCodes.ResolutionError);
}
catch (ParsingException parsingEx)
{
IList <ParsingError> errors = parsingEx.Errors;
string normalizedErrors = string.Empty;
foreach (ParsingError error in errors)
{
normalizedErrors += $"{Environment.NewLine}{error.Message}";
}
Outputs.WriteError(normalizedErrors);
return(ReturnCodes.ValidationError);
}
catch (IOException ioEx)
{
Outputs.WriteError(ioEx.Message);
return(ReturnCodes.InvalidArguments);
}
catch (ArgumentException argEx)
{
Outputs.WriteError(argEx.Message);
return(ReturnCodes.InvalidArguments);
}
catch (System.Text.Json.JsonException jsonEx)
{
Outputs.WriteError($"Parsing json-ld content. Details: {jsonEx.Message}");
return(ReturnCodes.InvalidArguments);
}
return(ReturnCodes.Success);
}
public async Task <List <string> > ExpandModel(FileInfo modelFile)
{
string dtmi = ParsingUtils.GetRootId(modelFile);
return(await ExpandModel(dtmi));
}