protected virtual Stream CreateSPFFieldSettingsPackage(ModelNode model, Action <SolutionPackageBase> action)
{
// save solution to XML file
var xmlContext = SPMeta2Model.ToXML(model);
// pack model
var solutionPackage = GetSolutionPackageTemplate();
// update version and add model
action(solutionPackage);
// create ModelContainerBase, put serialized model there
var modelContainer = new ModelContainerBase
{
Model = Encoding.UTF8.GetBytes(xmlContext),
};
solutionPackage.AddModel(modelContainer);
// pack to NuGet package
var packageService = new SPMeta2SolutionPackageService();
var solutionPackageStream = packageService.Pack(solutionPackage);
return(solutionPackageStream);
}
protected virtual ManifestFile GetModelManifestFile(ModelContainerBase model)
{
var result = new ManifestFile();
SerializationService.RegisterKnownType(typeof(ModelContainerBase));
SerializationService.RegisterKnownType(typeof(OptionValue));
var fileContent = SerializationService.Serialize(model);
var filePath = GetTempXmlFilePath();
result.Source = filePath;
result.Target = MetaPackConsts.ModelsContainerFolder + "/" + Path.GetFileName(filePath);
File.WriteAllText(filePath, fileContent);
return(result);
}
protected virtual SolutionPackageBase CreateNewSolutionPackage(
NuGetSolutionPackageService service,
Action <SolutionPackageBase> action,
RegressinModelLevel modelLevel)
{
var knownPackageType = false;
SolutionPackageBase solutionPackage = null;
if (service is SPMeta2SolutionPackageService)
{
var m2package = new SolutionPackageBase();
m2package.Name = "SPMeta2 CI Package Name";
m2package.Title = "SPMeta2 CI Package Title";
m2package.Description = "SPMeta2 CI Package description";
m2package.Id = "MetaPack.SPMeta2.CI";
m2package.Authors = "SubPoint Solutions Authors";
m2package.Company = "SubPoint Solutions Company";
m2package.Version = "1.0.0.0";
m2package.Owners = "SubPoint Solutions Owners";
m2package.ReleaseNotes = "ReleaseNotes";
m2package.Summary = "Summary";
m2package.ProjectUrl = "https://github.com/SubPointSolutions/metapack";
m2package.IconUrl = "https://github.com/SubPointSolutions/metapack/metapack.png";
m2package.LicenseUrl = "https://opensource.org/licenses/MIT";
m2package.Copyright = "Some copyright here";
m2package.Tags = "CI SPMeta2 MetaPack Tags";
var models = new List <ModelNode>();
switch (modelLevel)
{
case RegressinModelLevel.Farm:
models.Add(SPMeta2Model.NewFarmModel(farm => { }));
break;
case RegressinModelLevel.WebApplication:
models.Add(SPMeta2Model.NewWebApplicationModel(webApp => { }));
break;
case RegressinModelLevel.Site:
models.Add(SPMeta2Model.NewSiteModel(site => { }));
models.Add(SPMeta2Model.NewWebModel(web => { }));
break;
case RegressinModelLevel.Web:
models.Add(SPMeta2Model.NewWebModel(web => { }));
break;
case RegressinModelLevel.Subweb:
models.Add(SPMeta2Model.NewWebModel(web => { }));
break;
default:
throw new NotImplementedException(string.Format(
"Unsupported model level:[{0}] for model genaration",
modelLevel));
}
var index = 0;
foreach (var model in models)
{
index++;
var xmlContext = SPMeta2Model.ToXML(model);
var modelContainer = new ModelContainerBase
{
Model = Encoding.UTF8.GetBytes(xmlContext),
};
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = index.ToString()
});
m2package.AddModel(modelContainer);
}
m2package.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.SolutionToolPackage.PackageId.Id,
Value = "MetaPack.SPMeta2"
});
solutionPackage = m2package;
}
if (service is SharePointPnPSolutionPackageService)
{
var pnpPackage = new SolutionPackageBase();
pnpPackage.Name = "SharePointPnP CI Package Name";
pnpPackage.Title = "SharePointPnP Package Title";
pnpPackage.Description = "SPMeta2 CI Package description";
pnpPackage.Id = "MetaPack.SharePointPnP.CI";
pnpPackage.Authors = "SubPoint Solutions Authors";
pnpPackage.Company = "SubPoint Solutions Company";
pnpPackage.Version = "1.0.0.0";
pnpPackage.Owners = "SubPoint Solutions Owners";
pnpPackage.ReleaseNotes = "ReleaseNotes";
pnpPackage.Summary = "Summary";
pnpPackage.ProjectUrl = "https://github.com/SubPointSolutions/metapack";
pnpPackage.IconUrl = "https://github.com/SubPointSolutions/metapack/metapack.png";
pnpPackage.LicenseUrl = "https://opensource.org/licenses/MIT";
pnpPackage.Copyright = "Some copyright here";
pnpPackage.Tags = "CI SPMeta2 MetaPack Tags";
// TODO
// Zip up and set the model type
var asmFolder = Path.GetDirectoryName(GetType().Assembly.Location);
var foldersPath = Path.Combine(asmFolder, @"Data/PnPTemplates/Folders");
var openXmlFolderPath = Path.Combine(asmFolder, @"Data/PnPTemplates/OpenXML");
foreach (var templateFolder in Directory.GetDirectories(foldersPath))
{
// package up into zip
var templateFolderZipFile = GetTempZipFilePath();
ZipFile.CreateFromDirectory(templateFolder, templateFolderZipFile);
var modelContainer = new ModelContainerBase
{
Model = System.IO.File.ReadAllBytes(templateFolderZipFile),
};
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Type.Id,
Value = "SharePointPnP.FolderZip"
});
pnpPackage.AddModel(modelContainer);
}
var openXmlPackages = Directory.GetFiles(openXmlFolderPath, "*.pnp");
foreach (var file in openXmlPackages)
{
var modelContainer = new ModelContainerBase
{
Model = System.IO.File.ReadAllBytes(file),
};
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Type.Id,
Value = "SharePointPnP.OpenXml"
});
pnpPackage.AddModel(modelContainer);
}
pnpPackage.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.SolutionToolPackage.PackageId.Id,
Value = "MetaPack.SharePointPnP"
});
solutionPackage = pnpPackage;
}
if (solutionPackage == null)
{
throw new NotImplementedException(string.Format(
"Unknown service type:[{0}]", service.GetType()));
}
if (action != null)
{
action(solutionPackage);
}
return(solutionPackage);
}
public TableBuilder(ModelContainerBase model)
{
Model = model;
}
private void Can_Unpack_SolutionPackage_WithOrderedModel_Internal(NuGetSolutionPackageService s)
{
Can_Unpack_Internal(s,
prePackagedSolution =>
{
// clean models
var models = prePackagedSolution.GetModels().ToArray();
foreach (var model in models)
{
prePackagedSolution.RemoveModel(model);
}
var firstModel = new ModelContainerBase();
firstModel.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = "100"
});
var secondModel = new ModelContainerBase();
secondModel.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = "200"
});
var thirdModel = new ModelContainerBase();
thirdModel.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = "300"
});
prePackagedSolution.AddModel(secondModel);
prePackagedSolution.AddModel(firstModel);
prePackagedSolution.AddModel(thirdModel);
},
(rawPackage, unpackedPackage) =>
{
var solutionPackage = rawPackage as SolutionPackageBase;
var unpackedSolutionPackage = unpackedPackage as SolutionPackageBase;
Assert.IsNotNull(solutionPackage);
// these should be ordred by Order flag
var models = unpackedPackage.GetModels();
var orderValues = models.Select(m =>
{
var orderValue = m.AdditionalOptions
.FirstOrDefault(o => o.Name == DefaultOptions.Model.Order.Id);
return(int.Parse(orderValue.Value));
}).ToArray();
for (var index = 0; index < orderValues.Count() - 1; index++)
{
var firstOrder = orderValues[index];
var secondOrder = orderValues[index + 1];
Assert.IsTrue(firstOrder <= secondOrder);
}
// must be array of int-s
});
}
public void Create_Package_SPMeta2()
{
// Follows NuGet spec design - https://docs.nuget.org/ndocs/schema/nuspec
// Solution package is a container for SERIALIZED models.
var solutionPackage = new SolutionPackageBase();
solutionPackage.Name = "Contoso Intranet SPMeta2 - Site Fields";
solutionPackage.Title = "Contoso Intranet SPMeta2 - Site Fields";
solutionPackage.Description = "Contains site level fields for Contoso intranet";
solutionPackage.Id = "Contoso.Intranet.SiteFields.SPMeta2";
solutionPackage.Authors = "SubPoint Solutions";
solutionPackage.Company = "SubPoint Solutions";
solutionPackage.Version = "1.0.0.0";
solutionPackage.Owners = "SubPoint Solutions";
solutionPackage.ReleaseNotes = "Initial set of the site fields for Contoso Intranet";
solutionPackage.Summary = "All site fields required for Contoso intranet";
solutionPackage.ProjectUrl = "https://github.com/SubPointSolutions/DefinitelyPacked";
solutionPackage.IconUrl = "https://github.com/SubPointSolutions/metapack/metapack.png";
solutionPackage.LicenseUrl = "https://opensource.org/licenses/MIT";
solutionPackage.Copyright = "All yours";
solutionPackage.Tags = "MetaPack SPMeta2 SiteFields Taxonomy";
// here are all your SPMeta2 models
var models = new List <ModelNode>();
// create a new ModelContainerBase for every model
// and then add to solution package
// you can put "Order" option to control deployment order of the models
for (var index = 0; index < models.Count; index++)
{
var model = models[index];
var xmlContext = SPMeta2Model.ToXML(model);
// create ModelContainerBase, put serialized model there
var modelContainer = new ModelContainerBase
{
Model = Encoding.UTF8.GetBytes(xmlContext),
};
// add sort order to control deployment order of the models
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = index.ToString()
});
// add model container to solution
solutionPackage.AddModel(modelContainer);
}
// flag a provider which will be used for solution package deployment
solutionPackage.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.SolutionToolPackage.PackageId.Id,
Value = "MetaPack.SPMeta2"
});
var solutionPackageService = new SPMeta2SolutionPackageService();
// save your NuGet solution package as stream
var nuGetPackageStream = solutionPackageService.Pack(solutionPackage, null);
// or save it straight to file, for instance, on shared folder
solutionPackageService.PackToFile(solutionPackage, "Contoso.Intranet.SiteFields.SPMeta2.nupkg");
// or push it straight to NuGet gallery you've got - http://NuGet.org or http://MyGet.org
// follow instructions on how obtain Url/Key for a specific NuGet Gallery
var nuGetGallery_ApiUrl = "";
var nuGetGallery_ApiKey = "";
solutionPackageService.Push(solutionPackage, nuGetGallery_ApiUrl, nuGetGallery_ApiKey);
}
public void Create_Package_PnP()
{
// A high level abstraction for solution package.
// Follows NuGet spec design - https://docs.nuget.org/ndocs/schema/nuspec
// Solution package is a container for SERIALIZED models.
// It means that solution package does not depend on a particular API oe assembly so that models have to be in serialazable, platform and api independent way.
var solutionPackage = new SolutionPackageBase();
solutionPackage.Name = "Contoso Intranet PnP - Site Fields";
solutionPackage.Title = "Contoso Intranet PnP - Site Fields";
solutionPackage.Description = "Contains site level fields for Contoso intranet";
solutionPackage.Id = "Contoso.Intranet.SiteFields.PnP";
solutionPackage.Authors = "SubPoint Solutions";
solutionPackage.Company = "SubPoint Solutions";
solutionPackage.Version = "1.0.0.0";
solutionPackage.Owners = "SubPoint Solutions";
solutionPackage.ReleaseNotes = "Initial set of the site fields for Contoso Intranet";
solutionPackage.Summary = "All site fields required for Contoso intranet";
solutionPackage.ProjectUrl = "https://github.com/SubPointSolutions/DefinitelyPacked";
solutionPackage.IconUrl = "https://github.com/SubPointSolutions/metapack/metapack.png";
solutionPackage.LicenseUrl = "https://opensource.org/licenses/MIT";
solutionPackage.Copyright = "All yours";
solutionPackage.Tags = "MetaPack SPMeta2 SiteFields Taxonomy";
// create a new ModelContainerBase for every SharePointPnP solution
// * currently only OpenXML PnP packages as supported
// then add to solution package
// you can put "Order" option to control deployment order of the models
// all your SharePointPnP OpenXML packages
var allPnPOpenXmlFiles = new List <string>();
for (var index = 0; index < allPnPOpenXmlFiles.Count; index++)
{
var pnpPackageFilePath = allPnPOpenXmlFiles[index];
var pnpPackageBytes = System.IO.File.ReadAllBytes(pnpPackageFilePath);
var modelContainer = new ModelContainerBase
{
Model = pnpPackageBytes
};
// add sort order to control deployment order of the models
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Order.Id,
Value = index.ToString()
});
// add type of the SharePointPnP package
// current only OpenXml is supoported
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.Model.Type.Id,
Value = "SharePointPnP.OpenXml"
});
// add model container to solution
solutionPackage.AddModel(modelContainer);
}
// flag a provider which will be used for solution package deployment
solutionPackage.AdditionalOptions.Add(new OptionValue
{
Name = DefaultOptions.SolutionToolPackage.PackageId.Id,
Value = "MetaPack.SharePointPnP"
});
var solutionPackageService = new SharePointPnPSolutionPackageService();
// save your NuGet solution package as stream
var nuGetPackageStream = solutionPackageService.Pack(solutionPackage, null);
// or save it straight to file, for instance, on shared folder
solutionPackageService.PackToFile(solutionPackage, "Contoso.Intranet.SiteFields.PnP.nupkg");
// or push it straight to NuGet gallery you've got - http://NuGet.org or http://MyGet.org
// follow instructions on how obtain Url/Key for a specific NuGet Gallery
var nuGetGallery_ApiUrl = "";
var nuGetGallery_ApiKey = "";
solutionPackageService.Push(solutionPackage, nuGetGallery_ApiUrl, nuGetGallery_ApiKey);
}
protected virtual IEnumerable<Stream> CreateMetaPackPackages()
{
var result = new List<Stream>();
// pack model
var solutionPackage = GetSolutionPackageTemplate();
// update version and add model
solutionPackage.Version = "0.1.0-beta1";
var assemblyDirectoryPath = Path.GetDirectoryName(GetType().Assembly.Location);
var jQueryDirectoryPath = Path.Combine(assemblyDirectoryPath, "jQuery");
if (!Directory.Exists(jQueryDirectoryPath))
throw new Exception(string.Format("Cannot find directory:[{0}]", jQueryDirectoryPath));
var jQueryVersionFolderPaths = Directory.GetDirectories(jQueryDirectoryPath);
foreach (var versionFolderPath in jQueryVersionFolderPaths)
{
var jQueryVersion = Path.GetFileName(versionFolderPath);
var versionFolderName = (new DirectoryInfo(versionFolderPath)).Name;
var filePaths = Directory.GetFiles(versionFolderPath, "*.*");
// create model
var webModel = SPMeta2Model.NewWebModel(web =>
{
web.AddHostList(BuiltInListDefinitions.StyleLibrary, list =>
{
list.AddFolder(new FolderDefinition { Name = "jQuery" }, jQueryFolder =>
{
jQueryFolder.AddFolder(new FolderDefinition { Name = versionFolderName }, folder =>
{
foreach (var filePath in filePaths)
{
folder.AddModuleFile(new ModuleFileDefinition
{
FileName = Path.GetFileName(filePath),
Content = File.ReadAllBytes(filePath)
});
}
});
});
});
});
// save solution to XML file
var xmlContext = SPMeta2Model.ToXML(webModel);
// create ModelContainerBase, put serialized model there
var modelContainer = new ModelContainerBase
{
Model = Encoding.UTF8.GetBytes(xmlContext),
};
modelContainer.AdditionalOptions.Add(new OptionValue
{
Name = "_metapack.model.id",
Value = string.Format("jQuery.{0}", jQueryVersion)
});
solutionPackage.AddModel(modelContainer);
}
// pack to NuGet package
var packageService = new SPMeta2SolutionPackageService();
var solutionPackageStream = packageService.Pack(solutionPackage);
// add to result strems
result.Add(solutionPackageStream);
return result;
}
