Skip to content
This repository was archived by the owner on Dec 18, 2017. It is now read-only.

Change output structure of "kpm pack" #433

Merged
merged 3 commits into from
Jul 12, 2014
Merged

Change output structure of "kpm pack" #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e62e8f
Change output structure of "kpm pack"
ChengTian Jul 11, 2014
153d277
Enrich default exclude patterns of project and use them for filtering
ChengTian Jul 12, 2014
87ad748
Change default public app folder name to "public"
ChengTian Jul 12, 2014
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: 0 additions & 2 deletions src/Microsoft.Framework.PackageManager/Packing/PackManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,6 @@ public bool Package()
var root = new PackRoot(project, outputPath)
{
Overwrite = _options.Overwrite,
ZipPackages = _options.ZipPackages,
AppFolder = _options.AppFolder ?? project.Name,
Configuration = _options.Configuration,
Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did this get removed as part of this change?

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change of Helios and app layout makes bundled packages useless. So you want this change to be made in another PR?

NoSource = _options.NoSource
};
Expand Down
2 changes: 0 additions & 2 deletions src/Microsoft.Framework.PackageManager/Packing/PackOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ public class PackOptions

public FrameworkName RuntimeTargetFramework { get; set; }

public bool ZipPackages { get; set; }

public bool Overwrite { get; set; }

public bool NoSource { get; set; }
Expand Down
143 changes: 64 additions & 79 deletions src/Microsoft.Framework.PackageManager/Packing/PackProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,20 @@ public void EmitSource(PackRoot root)
throw new Exception("TODO: unable to resolve project named " + _libraryDescription.Identity.Name);
}

var targetName = AppFolder ?? project.Name;
var targetName = project.Name;
TargetPath = Path.Combine(root.OutputPath, PackRoot.AppRootName, "src", targetName);

Console.WriteLine(" Source {0}", project.ProjectDirectory);
Console.WriteLine(" Target {0}", TargetPath);

root.Operations.Delete(TargetPath);

// A set of excluded source files used as a filter when doing copy
var sourceExcludeFiles = new HashSet<string>(project.SourceExcludeFiles, StringComparer.OrdinalIgnoreCase);
// A set of excluded files used as a filter when doing copy
var excludeFiles = new HashSet<string>(project.ExcludeFiles, StringComparer.OrdinalIgnoreCase);

root.Operations.Copy(project.ProjectDirectory, TargetPath, (isRoot, filePath) =>
{
if (IsImplicitlyExcludedFile(filePath))
{
return false;
}

if (sourceExcludeFiles.Contains(filePath))
if (excludeFiles.Contains(filePath))
{
return false;
}
Expand All @@ -78,7 +73,7 @@ public void EmitNupkg(PackRoot root)
throw new Exception("TODO: unable to resolve project named " + _libraryDescription.Identity.Name);
}

var targetName = AppFolder ?? project.Name;
var targetName = project.Name;
var targetNupkgName = string.Format("{0}.{1}", targetName, project.Version);
TargetPath = Path.Combine(root.OutputPath, PackRoot.AppRootName, "packages", targetNupkgName);

Expand Down Expand Up @@ -132,28 +127,29 @@ public void EmitNupkg(PackRoot root)
}
}

private static bool IsImplicitlyExcludedFile(string filePath)
public void PostProcess(PackRoot root)
{
var fileExtension = Path.GetExtension(filePath);
var fileName = Path.GetFileName(filePath);

if (string.Equals(fileExtension, ".csproj", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".kproj", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".user", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".vspscc", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".vssscc", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".pubxml", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileName, "bin", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileName, "obj", StringComparison.OrdinalIgnoreCase))
Project project;
if (!_projectResolver.TryResolveProject(_libraryDescription.Identity.Name, out project))
{
return true;
throw new Exception("TODO: unable to resolve project named " + _libraryDescription.Identity.Name);
}
return false;
}

public void PostProcess(PackRoot root)
{
var binFolderPath = Path.Combine(TargetPath, "bin");
// Construct path to public app folder, which contains content files and tool dlls
// The name of public app folder is specified with "--appfolder" option
// Default name of public app folder is the same as main project
var appFolderName = AppFolder ?? PackRoot.DefaultAppFolderName;
var appFolderPath = Path.Combine(root.OutputPath, appFolderName);

// Delete old public app folder because we don't want leftovers from previous operations
root.Operations.Delete(appFolderPath);
Directory.CreateDirectory(appFolderPath);

// Copy content files (e.g. html, js and images) of main project into public app folder
CopyContentFiles(root, project, appFolderName);

// Tool dlls including AspNet.Loader.dll go to bin folder under public app folder
var appFolderBinPath = Path.Combine(appFolderPath, "bin");
Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between these folders

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

binFolderPath is approot\src\MainProject\bin, while appFolderBinPath is wwwroot\bin. approot and wwwroot are siblings.

Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the main project\bin relevant?

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we don't need MainProject\bin ? I just wanted to keep the completeness of MainProject. If you don't want bin in approot\src\MainProject, I can delete this logic.

Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What goes in it?

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AspNet.Loader.dll

Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea that's useless.

Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the wwwroot or the main app?

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's public app folder (i.e. wwwroot if you do --appfolder wwwroot).


var defaultRuntime = root.Runtimes.FirstOrDefault();
var iniFilePath = Path.Combine(TargetPath, "k.ini");
Expand All @@ -179,6 +175,18 @@ public void PostProcess(PackRoot root)
}
}

// Generate k.ini for public app folder
var appFolderIniFilePath = Path.Combine(appFolderPath, "k.ini");
var appBaseLine = string.Format("APP_BASE={0}",
Path.Combine("..", PackRoot.AppRootName, "src", project.Name));
var iniContents = string.Empty;
if (File.Exists(iniFilePath))
{
iniContents = File.ReadAllText(iniFilePath);
}
File.WriteAllText(appFolderIniFilePath,
string.Format("{0}{1}", iniContents, appBaseLine));

// Copy tools/*.dll into bin to support AspNet.Loader.dll
foreach (var package in root.Packages)
{
Expand All @@ -187,74 +195,51 @@ public void PostProcess(PackRoot root)
{
foreach (var packageToolFile in Directory.EnumerateFiles(packageToolsPath, "*.dll").Select(Path.GetFileName))
{
if (!Directory.Exists(binFolderPath))
if (!Directory.Exists(appFolderBinPath))
{
Directory.CreateDirectory(binFolderPath);
Directory.CreateDirectory(appFolderBinPath);
}

// Copy to bin folder under public app folder
File.Copy(
Path.Combine(packageToolsPath, packageToolFile),
Path.Combine(binFolderPath, packageToolFile),
Path.Combine(appFolderBinPath, packageToolFile),
true);
}
}
}
}

private void CopyContentFiles(PackRoot root, Project project, string appFolderName)
{
Console.WriteLine("Copying contents of project dependency {0} to {1}",
_libraryDescription.Identity.Name, appFolderName);

// Copy lib/**/*.dll into bin/$xxxxxxx.packages to support web deploy
if (root.ZipPackages)
var appFolderPath = Path.Combine(root.OutputPath, appFolderName);

Console.WriteLine(" Source {0}", project.ProjectDirectory);
Console.WriteLine(" Target {0}", appFolderPath);

// A set of content files that should be copied
var contentFiles = new HashSet<string>(project.ContentFiles, StringComparer.OrdinalIgnoreCase);

root.Operations.Copy(project.ProjectDirectory, appFolderPath, (isRoot, filePath) =>
{
if (!Directory.Exists(binFolderPath))
// We always explore a directory
if (Directory.Exists(filePath))
Copy link
Member

@davidfowl davidfowl Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We call this for directories as well? Why is that?

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the contentFiles (which is constructed from project.ContentFiles) above. It only contains files because PathResolver.PerformWildcardSearch(path, pattern) doesn't return directories, even the directory contains a file which matches given pattern. So we have to explore files under a directory in order to know whether we should include this directory.

Copy link
Contributor Author

@ChengTian ChengTian Jul 11, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, exploring a dir doesn't mean we copy it. We only create the dir in destination when there is a file in it needs to be copied.

{
Directory.CreateDirectory(binFolderPath);
return true;
}

var chars = "abcdefghijklmnopqrstuvwxyz0123456789";
var rnd = new Random();
var sequence = new string(Enumerable.Range(0, 7).Select(_ => chars[rnd.Next(chars.Length)]).ToArray());
var targetFile = Path.Combine(binFolderPath, "$" + sequence + ".packages");

using (var targetStream = new FileStream(targetFile, FileMode.Create, FileAccess.Write, FileShare.None))
var fileName = Path.GetFileName(filePath);
// Public app folder doesn't need project.json
if (string.Equals(fileName, "project.json", StringComparison.OrdinalIgnoreCase))
{
using (var archive = new ZipArchive(targetStream, ZipArchiveMode.Create))
{
foreach (var package in root.Packages)
{
root.Operations.AddFiles(
archive,
package.TargetPath,
Path.Combine("packages", package.Library.Name + "." + package.Library.Version),
IncludePackageFileInBundle);
}
foreach (var runtime in root.Runtimes)
{
//root.Operations.AddFiles(
// archive,
// root.Runtime.TargetPath,
// Path.Combine("packages", root.Runtime.Name + "." + root.Runtime.Version),
// IncludeRuntimeFileInBundle);
}
}
return false;
}
}
}

private bool IncludePackageFileInBundle(string relativePath, string fileName)
{
var fileExtension = Path.GetExtension(fileName);
var rootFolder = BasePath(relativePath);

if (/*string.Equals(rootFolder, "lib", StringComparison.OrdinalIgnoreCase) && */
string.Equals(fileExtension, ".dll", StringComparison.OrdinalIgnoreCase))
{
return true;
}
if (string.IsNullOrEmpty(relativePath) &&
(string.Equals(fileExtension, ".sha512", StringComparison.OrdinalIgnoreCase) ||
string.Equals(fileExtension, ".nuspec", StringComparison.OrdinalIgnoreCase)))
{
return true;
}
return false;
return contentFiles.Contains(filePath);
});
}

private bool IncludeRuntimeFileInBundle(string relativePath, string fileName)
Expand Down
7 changes: 3 additions & 4 deletions src/Microsoft.Framework.PackageManager/Packing/PackRoot.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ public class PackRoot
{
private readonly Runtime.Project _project;
public static readonly string AppRootName = "approot";
public static readonly string DefaultAppFolderName = "public";

public PackRoot(Runtime.Project project, string outputPath)
{
Expand All @@ -30,9 +31,7 @@ public PackRoot(Runtime.Project project, string outputPath)
public string OutputPath { get; private set; }
public string PackagesPath { get; private set; }

public string AppFolder { get; set; }
public bool Overwrite { get; set; }
public bool ZipPackages { get; set; }
public bool NoSource { get; set; }
public string Configuration { get; set; }

Expand Down Expand Up @@ -96,13 +95,13 @@ public void Emit()
{
File.WriteAllText(
Path.Combine(OutputPath, commandName + ".cmd"),
string.Format(template1, commandName, Path.Combine(AppRootName, "src", AppFolder ?? _project.Name), Runtimes.First().Name));
string.Format(template1, commandName, Path.Combine(AppRootName, "src", _project.Name), Runtimes.First().Name));
}
else
{
File.WriteAllText(
Path.Combine(OutputPath, commandName + ".cmd"),
string.Format(template2, commandName, Path.Combine(AppRootName, "src", AppFolder ?? _project.Name)));
string.Format(template2, commandName, Path.Combine(AppRootName, "src", _project.Name)));
}
}
}
Expand Down
6 changes: 1 addition & 5 deletions src/Microsoft.Framework.PackageManager/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,6 @@ public int Main(string[] args)
var argProject = c.Argument("[project]", "Path to project, default is current directory");
var optionOut = c.Option("-o|--out <PATH>", "Where does it go", CommandOptionType.SingleValue);
var optionConfiguration = c.Option("--configuration <CONFIGURATION>", "The configuration to use for deployment", CommandOptionType.SingleValue);
var optionZipPackages = c.Option("-z|--zippackages", "Bundle a zip full of packages",
CommandOptionType.NoValue);
var optionOverwrite = c.Option("--overwrite", "Remove existing files in target folders",
CommandOptionType.NoValue);
var optionNoSource = c.Option("--no-source", "Don't include sources of project dependencies",
Expand All @@ -156,10 +154,9 @@ public int Main(string[] args)

c.OnExecute(() =>
{
Console.WriteLine("verbose:{0} out:{1} zip:{2} project:{3}",
Console.WriteLine("verbose:{0} out:{1} project:{2}",
optionVerbose.HasValue(),
optionOut.Value(),
optionZipPackages.HasValue(),
argProject.Value);

var options = new PackOptions
Expand All @@ -169,7 +166,6 @@ public int Main(string[] args)
AppFolder = optionAppFolder.Value(),
Configuration = optionConfiguration.Value() ?? "debug",
RuntimeTargetFramework = _environment.TargetFramework,
ZipPackages = optionZipPackages.HasValue(),
Overwrite = optionOverwrite.HasValue(),
NoSource = optionNoSource.HasValue(),
Runtimes = optionRuntime.HasValue() ?
Expand Down
39 changes: 33 additions & 6 deletions src/Microsoft.Framework.Runtime/Project.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ public class Project
private static readonly char[] _sourceSeparator = new[] { ';' };

internal static readonly string[] _defaultSourcePatterns = new[] { @"**\*.cs" };
internal static readonly string[] _defaultSourceExcludePatterns = new[] { @"obj\**\*", @"bin\**\*" };
internal static readonly string[] _defaultExcludePatterns = new[] { @"obj\**\*", @"bin\**\*", @"**.csproj",
@"**.kproj", @"**.user", @"**.vspscc", @"**.vssscc", @"**.pubxml" };
internal static readonly string[] _defaultPreprocessPatterns = new[] { @"compiler\preprocess\**\*.cs" };
internal static readonly string[] _defaultSharedPatterns = new[] { @"compiler\shared\**\*.cs" };
internal static readonly string[] _defaultResourcesPatterns = new[] { @"compiler\resources\**\*" };
internal static readonly string[] _defaultContentsPatterns = new[] { @"**\*" };

private readonly Dictionary<FrameworkName, TargetFrameworkInformation> _targetFrameworks = new Dictionary<FrameworkName, TargetFrameworkInformation>();
private readonly Dictionary<FrameworkName, CompilerOptions> _compilationOptions = new Dictionary<FrameworkName, CompilerOptions>();
Expand Down Expand Up @@ -63,14 +65,16 @@ public string ProjectDirectory

internal IEnumerable<string> SourcePatterns { get; set; }

internal IEnumerable<string> SourceExcludePatterns { get; set; }
internal IEnumerable<string> ExcludePatterns { get; set; }

internal IEnumerable<string> PreprocessPatterns { get; set; }

internal IEnumerable<string> SharedPatterns { get; set; }

internal IEnumerable<string> ResourcesPatterns { get; set; }

internal IEnumerable<string> ContentsPatterns { get; set; }

public IEnumerable<string> SourceFiles
{
get
Expand All @@ -83,7 +87,7 @@ public IEnumerable<string> SourceFiles
.SelectMany(pattern => PathResolver.PerformWildcardSearch(path, pattern))
.ToArray();

var excludePatterns = PreprocessPatterns.Concat(SharedPatterns).Concat(ResourcesPatterns).Concat(SourceExcludePatterns)
var excludePatterns = PreprocessPatterns.Concat(SharedPatterns).Concat(ResourcesPatterns).Concat(ExcludePatterns)
.Select(pattern => PathResolver.NormalizeWildcardForExcludedFiles(path, pattern))
.ToArray();

Expand All @@ -94,13 +98,13 @@ public IEnumerable<string> SourceFiles
}
}

public IEnumerable<string> SourceExcludeFiles
public IEnumerable<string> ExcludeFiles
{
get
{
string path = ProjectDirectory;

var sourceExcludeFiles = SourceExcludePatterns
var sourceExcludeFiles = ExcludePatterns
.SelectMany(pattern => PathResolver.PerformWildcardSearch(path, pattern))
.ToArray();

Expand Down Expand Up @@ -136,6 +140,28 @@ public IEnumerable<string> SharedFiles
}
}

public IEnumerable<string> ContentFiles
{
get
{
string path = ProjectDirectory;

var includeFiles = ContentsPatterns
.SelectMany(pattern => PathResolver.PerformWildcardSearch(path, pattern))
.ToArray();

var excludePatterns = PreprocessPatterns.Concat(SharedPatterns).Concat(ResourcesPatterns)
.Concat(ExcludePatterns).Concat(SourcePatterns)
.Select(pattern => PathResolver.NormalizeWildcardForExcludedFiles(path, pattern))
.ToArray();

var excludeFiles = PathResolver.GetMatches(includeFiles, x => x, excludePatterns)
.ToArray();

return includeFiles.Except(excludeFiles).Distinct().ToArray();
}
}

public IDictionary<string, string> Commands { get; private set; }

public IEnumerable<TargetFrameworkInformation> GetTargetFrameworks()
Expand Down Expand Up @@ -207,10 +233,11 @@ public static Project GetProject(string json, string projectName, string project

// Source file patterns
project.SourcePatterns = GetSourcePattern(rawProject, "code", _defaultSourcePatterns);
project.SourceExcludePatterns = GetSourcePattern(rawProject, "exclude", _defaultSourceExcludePatterns);
project.ExcludePatterns = GetSourcePattern(rawProject, "exclude", _defaultExcludePatterns);
project.PreprocessPatterns = GetSourcePattern(rawProject, "preprocess", _defaultPreprocessPatterns);
project.SharedPatterns = GetSourcePattern(rawProject, "shared", _defaultSharedPatterns);
project.ResourcesPatterns = GetSourcePattern(rawProject, "resources", _defaultResourcesPatterns);
project.ContentsPatterns = GetSourcePattern(rawProject, "files", _defaultContentsPatterns);

// Set the default loader information for projects
var loaderAssemblyName = "Microsoft.Framework.Runtime.Roslyn";
Expand Down
Loading