public async Task SaveFundingTemplate_GivenInvalidTemplateDueToProfilePeriods_BadRequest()
{
//Arrange
string template = CreateJsonFile("CalculateFunding.Services.Policy.Resources.LogicalModelTemplate.json");
string fundingStreamId = "PES";
string templateVersion = "1.5";
string fundingPeriodId = "AY-2020";
FundingTemplateValidationResult validationResult = new FundingTemplateValidationResult
{
TemplateVersion = templateVersion,
FundingStreamId = fundingStreamId,
SchemaVersion = "1.0",
};
ITemplateMetadataResolver templateMetadataResolver = CreateMetadataResolver("1.0");
IFundingTemplateValidationService fundingTemplateValidationService = CreateFundingTemplateValidationService();
fundingTemplateValidationService
.ValidateFundingTemplate(Arg.Is(template), Arg.Is(fundingStreamId), Arg.Is(fundingPeriodId), Arg.Is(templateVersion))
.Returns(validationResult);
IFundingTemplateRepository fundingTemplateRepository = CreateFundingTemplateRepository();
ILogger logger = CreateLogger();
ICacheProvider cacheProvider = CreateCacheProvider();
FundingTemplateService fundingTemplateService = CreateFundingTemplateService(
logger,
fundingTemplateValidationService: fundingTemplateValidationService,
fundingTemplateRepository: fundingTemplateRepository,
cacheProvider: cacheProvider,
templateMetadataResolver: templateMetadataResolver);
//Act
IActionResult result = await fundingTemplateService.SaveFundingTemplate(createdAtActionName, createdAtControllerName, template, fundingStreamId, fundingPeriodId, templateVersion);
//Assert
result
.Should()
.BeAssignableTo <BadRequestObjectResult>();
BadRequestObjectResult badRequestObjectResult = result as BadRequestObjectResult;
SerializableError validationResults = badRequestObjectResult.Value as SerializableError;
validationResults
.Count()
.Should()
.Be(1);
((string[])validationResults["DistributionPeriods"])[0]
.Should()
.Be("Funding line : 'Total funding line' has values for the distribution periods");
}
public async Task <IActionResult> SaveFundingTemplate(string actionName, string controllerName, string template, string fundingStreamId, string fundingPeriodId, string templateVersion)
{
Guard.IsNullOrWhiteSpace(actionName, nameof(actionName));
Guard.IsNullOrWhiteSpace(controllerName, nameof(controllerName));
Guard.IsNullOrWhiteSpace(fundingStreamId, nameof(fundingStreamId));
Guard.IsNullOrWhiteSpace(fundingPeriodId, nameof(fundingPeriodId));
Guard.IsNullOrWhiteSpace(templateVersion, nameof(templateVersion));
//Already checked for null above when getting body
if (template.Trim() == string.Empty)
{
return(new BadRequestObjectResult("Null or empty funding template was provided."));
}
FundingTemplateValidationResult validationResult = await _fundingTemplateValidationService.ValidateFundingTemplate(template, fundingStreamId, fundingPeriodId, templateVersion);
if (!validationResult.IsValid)
{
return(validationResult.AsBadRequest());
}
ITemplateMetadataGenerator templateMetadataGenerator = _templateMetadataResolver.GetService(validationResult.SchemaVersion);
ValidationResult validationGeneratorResult = templateMetadataGenerator.Validate(template);
if (!validationGeneratorResult.IsValid)
{
return(validationGeneratorResult.PopulateModelState());
}
string blobName = GetBlobNameFor(validationResult.FundingStreamId, validationResult.FundingPeriodId, validationResult.TemplateVersion);
try
{
byte[] templateFileBytes = Encoding.UTF8.GetBytes(template);
await SaveFundingTemplateVersion(blobName, templateFileBytes);
string cacheKey = $"{CacheKeys.FundingTemplatePrefix}{validationResult.FundingStreamId}-{validationResult.FundingPeriodId}-{validationResult.TemplateVersion}".ToLowerInvariant();
await _cacheProviderPolicy.ExecuteAsync(() => _cacheProvider.RemoveAsync <string>(cacheKey));
await _cacheProviderPolicy.ExecuteAsync(() => _cacheProvider.RemoveAsync <FundingTemplateContents>($"{CacheKeys.FundingTemplateContents}{validationResult.FundingStreamId}:{validationResult.FundingPeriodId}:{validationResult.TemplateVersion}".ToLowerInvariant()));
await _cacheProviderPolicy.ExecuteAsync(() => _cacheProvider.RemoveAsync <TemplateMetadataContents>($"{CacheKeys.FundingTemplateContentMetadata}{validationResult.FundingStreamId}:{validationResult.FundingPeriodId}:{validationResult.TemplateVersion}".ToLowerInvariant()));
await _cacheProviderPolicy.ExecuteAsync(() => _cacheProvider.RemoveAsync <TemplateMetadataDistinctContents>($"{CacheKeys.FundingTemplateContentMetadataDistinct}{validationResult.FundingStreamId}:{validationResult.FundingPeriodId}:{validationResult.TemplateVersion}".ToLowerInvariant()));
return(new CreatedAtActionResult(actionName, controllerName, new { fundingStreamId = validationResult.FundingStreamId, fundingPeriodId = validationResult.FundingPeriodId, templateVersion = validationResult.TemplateVersion }, string.Empty));
}
catch (Exception ex)
{
_logger.Error(ex, $"Failed to save funding template '{blobName}' to blob storage");
return(new InternalServerErrorResult("Error occurred uploading funding template"));
}
}
public async Task SaveFundingTemplate_GivenTemplateButDidNotValidate_ReturnsBadRequest()
{
//Arrange
const string template = "a template";
string fundingStreamId = NewRandomString();
string templateVersion = NewRandomString();
string fundingPeriodId = NewRandomString();
FundingTemplateValidationResult validationResult = new FundingTemplateValidationResult();
validationResult.Errors.Add(new ValidationFailure("prop1", "an error"));
validationResult.Errors.Add(new ValidationFailure("prop2", "another error"));
IFundingTemplateValidationService fundingTemplateValidationService = CreateFundingTemplateValidationService();
fundingTemplateValidationService
.ValidateFundingTemplate(Arg.Is(template), Arg.Is(fundingStreamId), Arg.Is(fundingPeriodId), Arg.Is(templateVersion))
.Returns(validationResult);
FundingTemplateService fundingTemplateService = CreateFundingTemplateService(fundingTemplateValidationService: fundingTemplateValidationService);
//Act
IActionResult result = await fundingTemplateService.SaveFundingTemplate(createdAtActionName, createdAtControllerName, template, fundingStreamId, fundingPeriodId, templateVersion);
//Assert
result
.Should()
.BeAssignableTo <BadRequestObjectResult>();
BadRequestObjectResult badRequestObjectResult = result as BadRequestObjectResult;
badRequestObjectResult
.Value
.Should()
.BeOfType <SerializableError>();
SerializableError modelState = badRequestObjectResult.Value as SerializableError;
modelState
.Should()
.NotBeNull();
modelState
.Values
.Should()
.HaveCount(2);
}
private void SetupMocks()
{
_validatorFactory = Substitute.For <IIoCValidatorFactory>();
_validatorFactory.Validate(Arg.Any <object>()).Returns(new ValidationResult());
_templateRepository = Substitute.For <ITemplateRepository>();
_templateVersionFirst = new TemplateVersion
{
Name = "XXX 20-21",
TemplateId = _command.TemplateId,
TemplateJson = null,
Version = 1,
MinorVersion = 1,
MajorVersion = 0,
SchemaVersion = "1.1",
FundingStreamId = "XX",
FundingPeriodId = "20-21",
Status = TemplateStatus.Published,
Author = new Reference("111", "FirstTestUser")
};
_templateBeforeUpdate = new Template
{
Name = "Template Name",
Description = "Description",
TemplateId = _command.TemplateId,
FundingPeriod = new FundingPeriod
{
Id = "20-21",
Name = "Test Period",
Type = FundingPeriodType.FY
},
FundingStream = new FundingStream
{
Id = "XX",
ShortName = "XX",
Name = "FundingSteam"
},
Current = _templateVersionFirst
};
_templateMetadataGenerator = Substitute.For <ITemplateMetadataGenerator>();
_templateMetadataGenerator.Validate(Arg.Any <string>()).Returns(new ValidationResult());
_templateMetadataResolver = Substitute.For <ITemplateMetadataResolver>();
_templateMetadataResolver.GetService(Arg.Any <string>()).Returns(_templateMetadataGenerator);
_templateValidationService = Substitute.For <IFundingTemplateValidationService>();
_templateValidationService.ValidateFundingTemplate(Arg.Any <string>(), Arg.Any <string>(), Arg.Any <string>(), null).Returns(new FundingTemplateValidationResult {
});
_templateRepository.GetTemplate(Arg.Is(_command.TemplateId)).Returns(_templateBeforeUpdate);
_templateRepository.Update(Arg.Do <Template>(x => _savedTemplate = x)).Returns(HttpStatusCode.OK);
_versionRepository = Substitute.For <ITemplateVersionRepository>();
_versionRepository.SaveVersion(Arg.Do <TemplateVersion>(x => _savedTemplateVersion = x)).Returns(HttpStatusCode.OK);
_searchRepository = Substitute.For <ISearchRepository <TemplateIndex> >();
_searchRepository.Index(Arg.Any <IEnumerable <TemplateIndex> >()).Returns(Enumerable.Empty <IndexError>());
_policyRepository = Substitute.For <IPolicyRepository>();
_policyRepository.GetFundingPeriodById(Arg.Any <string>()).Returns(new FundingPeriod
{
Id = "2021",
Name = "Test Period",
Type = FundingPeriodType.FY
});
_policyRepository.GetFundingStreamById(Arg.Any <string>()).Returns(new FundingStream
{
Id = "XX",
ShortName = "XX",
Name = "FundingSteam"
});
_templateBlobService = Substitute.For <ITemplateBlobService>();
_templateBlobService.PublishTemplate(Arg.Any <Template>()).Returns(CommandResult.Success());
}
private void SetupMocks()
{
_validatorFactory = Substitute.For <IIoCValidatorFactory>();
_validatorFactory.Validate(Arg.Any <object>()).Returns(new ValidationResult());
_templateRepository = Substitute.For <ITemplateRepository>();
_sourceTemplateVersion = new TemplateVersion
{
Name = "Old Test Name",
TemplateId = _command.CloneFromTemplateId,
TemplateJson = "{ \"Lorem\": \"ipsum\" }",
Version = 12,
FundingPeriodId = "19-20",
FundingStreamId = "OLD",
MinorVersion = 1,
MajorVersion = 0,
SchemaVersion = "1.1",
Status = TemplateStatus.Draft,
Author = new Reference("111", "FirstTestUser")
};
_sourceTemplate = new Template
{
Name = _sourceTemplateVersion.Name,
Description = "Old description",
TemplateId = _command.CloneFromTemplateId,
FundingPeriod = new FundingPeriod
{
Id = "2021",
Name = "Test Period",
Type = FundingPeriodType.FY
},
FundingStream = new FundingStream
{
Id = "XX",
ShortName = "XX",
Name = "FundingSteam"
},
Current = _sourceTemplateVersion
};
_templateMetadataGenerator = Substitute.For <ITemplateMetadataGenerator>();
_templateMetadataGenerator.Validate(Arg.Any <string>()).Returns(new ValidationResult());
_templateMetadataResolver = Substitute.For <ITemplateMetadataResolver>();
_templateMetadataResolver.GetService(Arg.Any <string>()).Returns(_templateMetadataGenerator);
_templateValidationService = Substitute.For <IFundingTemplateValidationService>();
_templateValidationService.ValidateFundingTemplate(Arg.Any <string>(), Arg.Any <string>(), Arg.Any <string>(), null).Returns(new FundingTemplateValidationResult {
});
_templateRepository.GetTemplate(Arg.Is(_command.CloneFromTemplateId)).Returns(_sourceTemplate);
_templateRepository.GetAllTemplates().Returns(new[] { _sourceTemplate });
_templateRepository.CreateDraft(Arg.Any <Template>()).Returns(HttpStatusCode.OK);
_versionRepository = Substitute.For <ITemplateVersionRepository>();
_versionRepository.SaveVersion(Arg.Any <TemplateVersion>()).Returns(HttpStatusCode.OK);
_policyRepository = Substitute.For <IPolicyRepository>();
_policyRepository.GetFundingPeriods().Returns(new[] {
new FundingPeriod
{
Id = "2021",
Name = "Test Period",
Type = FundingPeriodType.FY
},
new FundingPeriod
{
Id = _command.FundingPeriodId,
Name = "Test Funding Period 2"
}
});
_policyRepository.GetFundingStreams().Returns(new[] {
new FundingStream
{
Id = "XX",
ShortName = "XX",
Name = "FundingSteam"
},
new FundingStream
{
Id = _command.FundingStreamId,
Name = "Funding Stream 2",
ShortName = "Stream 2"
}
});
_policyRepository.GetFundingConfigurations().Returns(new[] { new FundingConfiguration
{
FundingStreamId = _command.FundingStreamId,
FundingPeriodId = _command.FundingPeriodId
} });
_templateIndexer = Substitute.For <ISearchRepository <TemplateIndex> >();
_templateBlobService = Substitute.For <ITemplateBlobService>();
_templateBlobService.PublishTemplate(Arg.Any <Template>()).Returns(CommandResult.Success());
}
public async Task SaveFundingTemplate_GivenValidTemplateAndSaves_InvalidatesCacheReturnsCreatedAtActionResult()
{
//Arrange
string template = CreateJsonFile("CalculateFunding.Services.Policy.Resources.LogicalModelTemplateNoProfilePeriods.json");
string fundingStreamId = "PES";
string templateVersion = "1.5";
string fundingPeriodId = "AY-2020";
FundingTemplateValidationResult validationResult = new FundingTemplateValidationResult
{
TemplateVersion = templateVersion,
FundingStreamId = fundingStreamId,
SchemaVersion = "1.0",
FundingPeriodId = fundingPeriodId
};
string cacheKey = $"{CacheKeys.FundingTemplatePrefix}{validationResult.FundingStreamId}-{validationResult.FundingPeriodId}-{validationResult.TemplateVersion}".ToLowerInvariant();
ITemplateMetadataResolver templateMetadataResolver = CreateMetadataResolver("1.0");
IFundingTemplateValidationService fundingTemplateValidationService = CreateFundingTemplateValidationService();
fundingTemplateValidationService
.ValidateFundingTemplate(Arg.Is(template), Arg.Is(fundingStreamId), Arg.Is(fundingPeriodId), Arg.Is(templateVersion))
.Returns(validationResult);
IFundingTemplateRepository fundingTemplateRepository = CreateFundingTemplateRepository();
ILogger logger = CreateLogger();
ICacheProvider cacheProvider = CreateCacheProvider();
FundingTemplateService fundingTemplateService = CreateFundingTemplateService(
logger,
fundingTemplateValidationService: fundingTemplateValidationService,
fundingTemplateRepository: fundingTemplateRepository,
cacheProvider: cacheProvider,
templateMetadataResolver: templateMetadataResolver);
//Act
IActionResult result = await fundingTemplateService.SaveFundingTemplate(createdAtActionName, createdAtControllerName, template, fundingStreamId, fundingPeriodId, templateVersion);
//Assert
result
.Should()
.BeAssignableTo <CreatedAtActionResult>();
CreatedAtActionResult actionResult = result as CreatedAtActionResult;
actionResult
.ActionName
.Should()
.Be(createdAtActionName);
actionResult
.ControllerName
.Should()
.Be(createdAtControllerName);
actionResult
.RouteValues["fundingStreamId"].ToString()
.Should()
.Be("PES");
actionResult
.RouteValues["fundingPeriodId"].ToString()
.Should()
.Be("AY-2020");
actionResult
.RouteValues["templateVersion"].ToString()
.Should()
.Be("1.5");
await
cacheProvider
.Received(1)
.RemoveAsync <string>(Arg.Is(cacheKey));
await
cacheProvider
.Received(1)
.RemoveAsync <FundingTemplateContents>(Arg.Is($"{CacheKeys.FundingTemplateContents}pes:ay-2020:1.5"));
await cacheProvider
.Received(1)
.RemoveAsync <TemplateMetadataContents>($"{CacheKeys.FundingTemplateContentMetadata}pes:ay-2020:1.5");
await cacheProvider
.Received(1)
.RemoveAsync <TemplateMetadataDistinctContents>($"{CacheKeys.FundingTemplateContentMetadataDistinct}pes:ay-2020:1.5");
}
public async Task SaveFundingTemplate_GivenValidTemplateButFailedToSaveToBlobStorage_ReturnsInternalServerError()
{
//Arrange
const string template = "a template";
string fundingStreamId = NewRandomString();
string templateVersion = NewRandomString();
string fundingPeriodId = NewRandomString();
FundingTemplateValidationResult validationResult = new FundingTemplateValidationResult
{
TemplateVersion = "1.8",
FundingStreamId = "PES",
SchemaVersion = "1.0",
FundingPeriodId = "AY-2020"
};
string blobName = $"{validationResult.FundingStreamId}/{validationResult.FundingPeriodId}/{validationResult.TemplateVersion}.json";
IFundingTemplateValidationService fundingTemplateValidationService = CreateFundingTemplateValidationService();
fundingTemplateValidationService
.ValidateFundingTemplate(Arg.Is(template), Arg.Is(fundingStreamId), Arg.Is(fundingPeriodId), Arg.Is(templateVersion))
.Returns(validationResult);
IFundingTemplateRepository fundingTemplateRepository = CreateFundingTemplateRepository();
fundingTemplateRepository
.When(x => x.SaveFundingTemplateVersion(Arg.Is(blobName), Arg.Any <byte[]>()))
.Do(x => { throw new Exception(); });
ILogger logger = CreateLogger();
ITemplateMetadataGenerator templateMetadataGenerator = CreateMetadataGenerator();
templateMetadataGenerator.Validate(Arg.Is <string>(template))
.Returns(new FluentValidation.Results.ValidationResult());
ITemplateMetadataResolver templateMetadataResolver = CreateMetadataResolver("1.0", templateMetadataGenerator);
FundingTemplateService fundingTemplateService = CreateFundingTemplateService(
logger,
fundingTemplateValidationService: fundingTemplateValidationService,
fundingTemplateRepository: fundingTemplateRepository,
templateMetadataResolver: templateMetadataResolver);
//Act
IActionResult result = await fundingTemplateService.SaveFundingTemplate(createdAtActionName, createdAtControllerName, template, fundingStreamId, fundingPeriodId, templateVersion);
//Assert
result
.Should()
.BeAssignableTo <InternalServerErrorResult>()
.Which
.Value
.Should()
.Be("Error occurred uploading funding template");
logger
.Received(1)
.Error(Arg.Any <NonRetriableException>(), Arg.Is($"Failed to save funding template '{blobName}' to blob storage"));
}