Skip to content

Add Logging to Releasify #1432

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
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Add Logging to Releasify #1432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5ba59ae
Add Logging to Releasify
Horb Nov 16, 2018
875fe58
Don't prefix method names. Remove private access modifiers.
Horb Jan 2, 2019
df3e46c
Introduce instance variables instead of passing many arguments.
Horb Jan 2, 2019
67fa86e
Alias workaround no longer required.
Horb Jan 2, 2019
df8d964
Revert "Build: Fix Reference HintPaths."
Horb Jan 2, 2019
17314f2
Sort and move instance variables based on when they're used.
Horb Jan 2, 2019
f184389
Remove signingOpts and just use signingParameters.
Horb Jan 2, 2019
ed47148
Rearrange to reduce diff.
Horb Jan 2, 2019
06fc423
Remove package instance variable. Use target instead.
Horb Jan 3, 2019
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
127 changes: 91 additions & 36 deletions src/Update/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ int main(string[] args)
}
}

string target = default(string);
string packagesDir = default(string);
string bootstrapperExe = default(string);
string backgroundGif = default(string);
string baseUrl = default(string);
string signingParameters = default(string);
string setupIcon = default(string);
string frameworkVersion = "net45";
bool noMsi = (Environment.OSVersion.Platform != PlatformID.Win32NT); // NB: WiX doesn't work under Mono / Wine
bool noDelta = false;

int executeCommandLine(string[] args)
{
var animatedGifWindowToken = new CancellationTokenSource();
Expand Down Expand Up @@ -84,22 +95,12 @@ int executeCommandLine(string[] args)
bool silentInstall = false;
var updateAction = default(UpdateAction);

string target = default(string);
string releaseDir = default(string);
string packagesDir = default(string);
string bootstrapperExe = default(string);
string backgroundGif = default(string);
string signingParameters = default(string);
string baseUrl = default(string);
string processStart = default(string);
string processStartArgs = default(string);
string setupIcon = default(string);
string icon = default(string);
string shortcutArgs = default(string);
string frameworkVersion = "net45";
bool shouldWait = false;
bool noMsi = (Environment.OSVersion.Platform != PlatformID.Win32NT); // NB: WiX doesn't work under Mono / Wine
bool noDelta = false;

opts = new OptionSet() {
"Usage: Squirrel.exe command [OPTS]",
Expand Down Expand Up @@ -184,7 +185,7 @@ int executeCommandLine(string[] args)
break;
#endif
case UpdateAction.Releasify:
Releasify(target, releaseDir, packagesDir, bootstrapperExe, backgroundGif, signingParameters, baseUrl, setupIcon, !noMsi, frameworkVersion, !noDelta);
Releasify();
break;
}
}
Expand Down Expand Up @@ -343,10 +344,29 @@ public async Task Uninstall(string appName = null)
}
}

public void Releasify(string package, string targetDir = null, string packagesDir = null, string bootstrapperExe = null, string backgroundGif = null, string signingOpts = null, string baseUrl = null, string setupIcon = null, bool generateMsi = true, string frameworkVersion = null, bool generateDeltas = true)
public void Releasify()
{
ensureConsole();
try {
this.Log().Debug("Begin Releasify");
ensureConsole();
ValidateBaseUrl();
ValidatePaths();
PrepareFiles();
ProcessFiles();
CleanupFiles();
WriteReleaseFile();
CreateSetupExe();
GenerateMsi();
this.Log().Debug("Completed Releasify");
} catch (Exception ex) {
this.Log().Error(ex);
throw;
}
}

void ValidateBaseUrl()
{
this.Log().Debug("Validating BaseUrl");
if (baseUrl != null) {
if (!Utility.IsHttpUrl(baseUrl)) {
throw new Exception(string.Format("Invalid --baseUrl '{0}'. A base URL must start with http or https and be a valid URI.", baseUrl));
Expand All @@ -356,7 +376,12 @@ public void Releasify(string package, string targetDir = null, string packagesDi
baseUrl += "/";
}
}
}

string targetDir;
void ValidatePaths()
{
this.Log().Debug("Validating Paths");
targetDir = targetDir ?? Path.Combine(".", "Releases");
packagesDir = packagesDir ?? ".";
bootstrapperExe = bootstrapperExe ?? Path.Combine(".", "Setup.exe");
Expand All @@ -370,29 +395,41 @@ public void Releasify(string package, string targetDir = null, string packagesDi
Path.GetDirectoryName(Assembly.GetEntryAssembly().Location),
"Setup.exe");
}

this.Log().Info("Bootstrapper EXE found at:" + bootstrapperExe);
}

var di = new DirectoryInfo(targetDir);
File.Copy(package, Path.Combine(di.FullName, Path.GetFileName(package)), true);
DirectoryInfo targetDirInfo;
IEnumerable<FileInfo> toProcess;
List<string> processed;
string releaseFilePath;
List<ReleaseEntry> previousReleases;
void PrepareFiles()
{
this.Log().Debug("Preparing Files");
targetDirInfo = new DirectoryInfo(targetDir);
File.Copy(target, Path.Combine(targetDirInfo.FullName, Path.GetFileName(target)), true);

var allNuGetFiles = di.EnumerateFiles()
var allNuGetFiles = targetDirInfo.EnumerateFiles()
.Where(x => x.Name.EndsWith(".nupkg", StringComparison.OrdinalIgnoreCase));

var toProcess = allNuGetFiles.Where(x => !x.Name.Contains("-delta") && !x.Name.Contains("-full"));
var processed = new List<string>();
toProcess = allNuGetFiles.Where(x => !x.Name.Contains("-delta") && !x.Name.Contains("-full"));
processed = new List<string>();

var releaseFilePath = Path.Combine(di.FullName, "RELEASES");
var previousReleases = new List<ReleaseEntry>();
releaseFilePath = Path.Combine(targetDirInfo.FullName, "RELEASES");
previousReleases = new List<ReleaseEntry>();
if (File.Exists(releaseFilePath)) {
previousReleases.AddRange(ReleaseEntry.ParseReleaseFile(File.ReadAllText(releaseFilePath, Encoding.UTF8)));
}
}

void ProcessFiles()
{
this.Log().Debug("Processing Files");
foreach (var file in toProcess) {
this.Log().Info("Creating release package: " + file.FullName);

var rp = new ReleasePackage(file.FullName);
rp.CreateReleasePackage(Path.Combine(di.FullName, rp.SuggestedReleaseFileName), packagesDir, contentsPostProcessHook: pkgPath => {
rp.CreateReleasePackage(Path.Combine(targetDirInfo.FullName, rp.SuggestedReleaseFileName), packagesDir, contentsPostProcessHook: pkgPath => {
new DirectoryInfo(pkgPath).GetAllFilesRecursively()
.Where(x => x.Name.ToLowerInvariant().EndsWith(".exe"))
.Where(x => !x.Name.ToLowerInvariant().Contains("squirrel.exe"))
Expand All @@ -401,7 +438,7 @@ public void Releasify(string package, string targetDir = null, string packagesDi
.ForEachAsync(x => createExecutableStubForExe(x.FullName))
.Wait();

if (signingOpts == null) return;
if (signingParameters == null) return;

new DirectoryInfo(pkgPath).GetAllFilesRecursively()
.Where(x => Utility.FileIsLikelyPEImage(x.Name))
Expand All @@ -412,39 +449,53 @@ public void Releasify(string package, string targetDir = null, string packagesDi
}

this.Log().Info("About to sign {0}", x.FullName);
await signPEFile(x.FullName, signingOpts);
await signPEFile(x.FullName, signingParameters);
}, 1)
.Wait();
});

processed.Add(rp.ReleasePackageFile);

var prev = ReleaseEntry.GetPreviousRelease(previousReleases, rp, targetDir);
if (prev != null && generateDeltas) {
if (prev != null && !noDelta) {
var deltaBuilder = new DeltaPackageBuilder(null);

var dp = deltaBuilder.CreateDeltaPackage(prev, rp,
Path.Combine(di.FullName, rp.SuggestedReleaseFileName.Replace("full", "delta")));
Path.Combine(targetDirInfo.FullName, rp.SuggestedReleaseFileName.Replace("full", "delta")));
processed.Insert(0, dp.InputPackageFile);
}
}
}

void CleanupFiles()
{
this.Log().Debug("Cleaning Up Files");
foreach (var file in toProcess) { File.Delete(file.FullName); }
}

List<ReleaseEntry> releaseEntries;
void WriteReleaseFile()
{
this.Log().Debug("Writing RELEASES file");
var newReleaseEntries = processed
.Select(packageFilename => ReleaseEntry.GenerateFromFile(packageFilename, baseUrl))
.ToList();
var distinctPreviousReleases = previousReleases
.Where(x => !newReleaseEntries.Select(e => e.Version).Contains(x.Version));
var releaseEntries = distinctPreviousReleases.Concat(newReleaseEntries).ToList();
releaseEntries = distinctPreviousReleases.Concat(newReleaseEntries).ToList();

ReleaseEntry.WriteReleaseFile(releaseEntries, releaseFilePath);
}

var targetSetupExe = Path.Combine(di.FullName, "Setup.exe");
string targetSetupExe;
void CreateSetupExe()
{
this.Log().Debug("Creating Setup.exe");
targetSetupExe = Path.Combine(targetDirInfo.FullName, "Setup.exe");
var newestFullRelease = releaseEntries.MaxBy(x => x.Version).Where(x => !x.IsDelta).First();

File.Copy(bootstrapperExe, targetSetupExe, true);
var zipPath = createSetupEmbeddedZip(Path.Combine(di.FullName, newestFullRelease.Filename), di.FullName, backgroundGif, signingOpts, setupIcon).Result;
var zipPath = createSetupEmbeddedZip(Path.Combine(targetDirInfo.FullName, newestFullRelease.Filename), targetDirInfo.FullName, backgroundGif, signingParameters, setupIcon).Result;

var writeZipToSetup = Utility.FindHelperExecutable("WriteZipToSetup.exe");

Expand All @@ -459,17 +510,21 @@ public void Releasify(string package, string targetDir = null, string packagesDi
}

Utility.Retry(() =>
setPEVersionInfoAndIcon(targetSetupExe, new ZipPackage(package), setupIcon).Wait());
setPEVersionInfoAndIcon(targetSetupExe, new ZipPackage(target), setupIcon).Wait());

if (signingOpts != null) {
signPEFile(targetSetupExe, signingOpts).Wait();
if (signingParameters != null) {
signPEFile(targetSetupExe, signingParameters).Wait();
}
}

if (generateMsi) {
createMsiPackage(targetSetupExe, new ZipPackage(package)).Wait();
void GenerateMsi()
{
if (!noMsi) {
this.Log().Debug("Generating .msi");
createMsiPackage(targetSetupExe, new ZipPackage(target)).Wait();

if (signingOpts != null) {
signPEFile(targetSetupExe.Replace(".exe", ".msi"), signingOpts).Wait();
if (signingParameters != null) {
signPEFile(targetSetupExe.Replace(".exe", ".msi"), signingParameters).Wait();
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions src/Update/Update.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
</PropertyGroup>
<ItemGroup>
<Reference Include="DeltaCompressionDotNet">
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net20\DeltaCompressionDotNet.dll</HintPath>
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net45\DeltaCompressionDotNet.dll</HintPath>
</Reference>
<Reference Include="DeltaCompressionDotNet.MsDelta">
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net20\DeltaCompressionDotNet.MsDelta.dll</HintPath>
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net45\DeltaCompressionDotNet.MsDelta.dll</HintPath>
</Reference>
<Reference Include="DeltaCompressionDotNet.PatchApi">
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net20\DeltaCompressionDotNet.PatchApi.dll</HintPath>
<HintPath>..\..\packages\DeltaCompressionDotNet.1.1.0\lib\net45\DeltaCompressionDotNet.PatchApi.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Web.XmlTransform">
<HintPath>..\..\packages\Microsoft.Web.Xdt.2.1.1\lib\net40\Microsoft.Web.XmlTransform.dll</HintPath>
Expand Down