Use minor upgrade mechanism for updates, set installer versionautomatically

build_release.py

Index: build_release.py
===================================================================
rename from build_release.bat
rename to build_release.py
--- a/build_release.bat
+++ b/build_release.py
@@ -1,30 +1,62 @@
-@echo off
+#!/usr/bin/env python
 
-if %1.==. goto NoKey
+import sys, os, re, subprocess
 
-pushd %~dp0
-call libadblockplus\createsolution.bat
-msbuild libadblockplus\build\ia32\libadblockplus.sln /p:Configuration=Release
-msbuild libadblockplus\build\x64\libadblockplus.sln /p:Configuration=Release
-msbuild AdblockPlus.sln "/p:Configuration=Release Test" /p:Platform=Win32
-msbuild AdblockPlus.sln "/p:Configuration=Release Test" /p:Platform=x64
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\ia32\Release Test\AdblockPlus.dll"
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\x64\Release Test\AdblockPlusx64.dll"
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\ia32\Release Test\AdblockPlusEngine.exe"
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\x64\Release Test\AdblockPlusEngine.exe"
+if len(sys.argv) < 2:
+  print >>sys.stderr, "Please add a command line parameter with the path of the signing key file"
+  sys.exit(1)
 
-pushd WixInstaller
-nmake
-popd
+basedir = os.path.dirname(os.path.abspath(sys.argv[0]))
+key = sys.argv[1]
 
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\ia32\adblockplusie-en-us-ia32.msi"
-signtool.exe sign /v /d "Adblock Plus" /du "http://adblockplus.org/" /f %1 /tr "http://www.startssl.com/timestamp" "build\x64\adblockplusie-en-us-x64.msi"
+def sign(*argv):
+  subprocess.call([
+    "signtool",
+    "sign", "/v",
+    "/d", "Adblock Plus",
+    "/du", "http://adblockplus.org/",
+    "/f", key,
+    "/tr", "http://www.startssl.com/timestamp"
+  ] + list(argv))
 
-popd
-goto End
+def read_macro_value(file, macro):
+  handle = open(file, 'rb')
+  for line in handle:
+    match = re.search(r"^\s*#define\s+%s\s+\w?\"(.*?)\"" % macro, line)
+    if match:
+      return match.group(1)
+  raise Exception("Macro %s not found in file %s" % (macro, file))
 
-:NoKey
-  echo Please add a command line parameter with the path of the signing key file
-  goto End
+version = read_macro_value(os.path.join(basedir, "src", "shared", "Version.h"), "IEPLUGIN_VERSION");
+buildnum, dummy = subprocess.Popen(['hg', 'id', '-R', basedir, '-n'], stdout=subprocess.PIPE).communicate()

[Felix Dahlke, 2013/06/11 13:53:22]

I'd consider buildnum = subprocess.Popen(...).communicate()[0] cleaner.

[Wladimir Palant, 2013/06/11 14:43:18]

Seriously? [0] at the end of a long line is very non-obvious IMHO.

+buildnum = re.sub(r'\D', '', buildnum)
+while version.count(".") < 1:
+  version += ".0"
+version += ".%s" % buildnum
 
-:End
+subprocess.call([os.path.join(basedir, "libadblockplus", "createsolution.bat")])
+
+for arch in ("ia32", "x64"):
+  platform = "/p:Platform=%s" % {"ia32": "Win32", "x64": "x64"}[arch]
+  subprocess.call([
+    "msbuild",
+    os.path.join(basedir, "libadblockplus", "build", arch, "libadblockplus.sln"),
+    "/p:Configuration=Release",
+    platform
+  ])
+
+  subprocess.call([
+    "msbuild",
+    os.path.join(basedir, "AdblockPlus.sln"),
+    "/p:Configuration=Release Test",
+    platform])
+
+  plugin = {"ia32": "AdblockPlus.dll", "x64": "AdblockPlusx64.dll"}[arch]
+  sign(os.path.join(basedir, "build", arch, "Release Test", plugin),
+      os.path.join(basedir, "build", arch, "Release Test", "AdblockPlusEngine.exe"))
+
+installerParams = os.environ.copy()
+installerParams["VERSION"] = version
+subprocess.call(["nmake"], env=installerParams, cwd=os.path.join(basedir, "WixInstaller"))
+sign(os.path.join(basedir, "build", "ia32", "adblockplusie-%s-en-us-ia32.msi" % version),
+    os.path.join(basedir, "build", "x64", "adblockplusie-%s-en-us-x64.msi" % version))

[Eric, 2013/06/11 15:41:46]

I would redo the batch file as a Makefile rather than as a python script. I've
used the batch file regularly to do whole builds just for testing the installer,
but (for example) the requirement for signing always generates errors that I
have to manually ensure aren't fatal. In other words, there are two reasons to
do a full build like this. One is to build for release, the other is to build
all the assets for testing installers. This is best done with a Makefile so that
we can specify multiple targets. 

I can write the Makefile, and we can go with this script for now. We'll likely
need to keep a bit of the python script that invokes 'hg' to grab the current
version number, but as I mentioned in another comment I don't need the release
version number to test the installer.

[Wladimir Palant, 2013/06/12 09:46:34]

I would definitely be opposed to that - a Makefile is very inflexible (in
particular, getting the version number from Version.h should be difficult) and
hard to maintain. Note in particular how nmake is dependent on the current work
directory. We have a dependency on Python anyway (via libadblockplus and gyp),
so we should use it.
Do you want to change that script then to make signing optional then? The script
can show a warning if the signing file is missing, along the lines of: "Warning:
Creating an unsigned build. Add the path to the signing file as a command line
parameter to create a signed build."
The handling of command line parameters for this script can easily be changed.

[Eric, 2013/06/12 14:33:24]

(as I mentioned in email) The incremental calculation part of 'make' is the
thing I need the most. Not simple to do in a python script.