component/firefox: simplify profile

Major change is that slapos compatible wrapper is no longer installed in
parts/firefox/firefox-slapos , but directly as "firefox" in the
buildout:bin-directory of the software profile.
geckodriver is also in the same buildout:bin-directory.
This way, softwares using this just need to add
buildout:bin-directory to $PATH

erp5testnode knows since
nexedi/erp5@59ee7970
that it should look for firefox in buildout:bin-directory of the
installed SR, so we should not need backward compatibility here.

Adjust seleniumrunner and jstestnode for the changes

Also drop unused firefox 45

Jérome changes from original 8cf6908df752b9e7632b2910ffc85027f1f4f22c :
 - name sections [firefox-wrapper] and [firefox] because including the
version in section name means we have to also update section name when
we update version. Users have to be careful of installing
${firefox-wrapper:} and not ${firefox:}
 - introduce macros for implementation and simple section using the
macros, to make it easy to had more versions or to increase versions,
for both firefox and geckodriver. They are slightly different because
for firefox we need a wrapper, but geckodriver is usable directly.
 - use same version, the "versions up" will be separate commits.
 - now that seleniumrunner and jstestnode are using buildout.hash.cfg,
md5sums are in separate files.
Co-authored-by: Jérome Perrin <jerome@nexedi.com>

component/firefox/buildout.cfg

 [buildout]
 extends =
   ../alsa/buildout.cfg
-  ../dash/buildout.cfg
   ../dbus/buildout.cfg
   ../fontconfig/buildout.cfg
   ../gtk-2/buildout.cfg
@@ -15,152 +14,143 @@ extends =
   ../xz-utils/buildout.cfg
 
 parts =
-  firefox
+  firefox-wrapper
+  geckodriver
 
 # XXX : Firefox binary tries to find libgnomeui-2.so.0 and it will
 # fail to run if exists.
 
+
+[firefox-wrapper]
+# Install a firefox wrapper names ${:wrapper-name} in buildout's bin-directory,
+# wrapping firefox installed in ${:part}
+# This [firefox-wrapper] installs the default firefox with name `firefox` and
+# can also be used as a macro to install under a different name.
+wrapper-name = firefox
+part = ${firefox:location}
+
+recipe = slapos.recipe.build
+location = ${buildout:bin-directory}/${:wrapper-name}
+part = ${firefox:location}
+script =
+  firefox = self.options['part']
+  part = self.buildout[os.path.basename(firefox)]
+  with open(%(location)r, 'w') as f:
+    f.write("""#!/bin/sh -e
+  cd %%s
+  export LD_LIBRARY_PATH=$PWD:%%s
+  export PATH=%%s:$PATH
+  exec ./firefox "$@" 2>/dev/null
+  """ %% (
+    firefox,
+    ':'.join(part['library'].split()),
+    ':'.join(part['path'].split()),
+  ))
+    os.fchmod(f.fileno(), 0o755)
+
+[firefox-wrapper-51]
+<= firefox-wrapper
+wrapper-name = firefox-51
+part = ${firefox-51:location}
+
+
+
 [firefox]
+# The default installed firefox version when installing firefox-wrapper.
+# Note that users must install ${firefox-wrapper:} to have a usable firefox
+# installed in ${buildout:bin-directory}.
+# Installing ${firefox:} is not enough, because wrapper setting $LD_LIBRARY_PATH
+# would not be created.
 <= firefox-51
 
 [firefox-51]
+<= firefox-download
+version = 51.0.1
+i686-md5sum = 9a5b67e9d759a1e4df004294a24b2b43
+x86_64-md5sum = bd93f2652d1d90d59ae462439a93c85f
+
+
+[firefox-download]
 recipe = slapos.recipe.build
 slapos_promise =
   file:firefox
-  file:firefox-bin
 
-depends =
+x86 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-i686/en-US/firefox-${:version}.tar.bz2 ${:i686-md5sum}
+x86-64 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-x86_64/en-US/firefox-${:version}.tar.bz2 ${:x86_64-md5sum}
+
+fonts =
   ${liberation-fonts:location}
   ${ipaex-fonts:location}
+library =
+  ${alsa:location}/lib
+  ${atk:location}/lib
+  ${at-spi2-atk:location}/lib
+  ${at-spi2-core:location}/lib
+  ${bzip2:location}/lib
+  ${cairo:location}/lib
+  ${dbus:location}/lib
+  ${dbus-glib:location}/lib
+  ${fontconfig:location}/lib
+  ${freetype:location}/lib
+  ${gdk-pixbuf:location}/lib
+  ${gettext:location}/lib
+  ${glib:location}/lib
+  ${gtk-3:location}/lib
+  ${harfbuzz:location}/lib
+  ${libepoxy:location}/lib
+  ${libffi:location}/lib
+  ${libICE:location}/lib
+  ${libpng:location}/lib
+  ${libSM:location}/lib
+  ${libtool:location}/lib
+  ${libuuid:location}/lib
+  ${libX11:location}/lib
+  ${libXau:location}/lib
+  ${libxcb:location}/lib
+  ${libXcomposite:location}/lib
+  ${libXcursor:location}/lib
+  ${libXext:location}/lib
+  ${libXi:location}/lib
+  ${libxml2:location}/lib
+  ${libXrender:location}/lib
+  ${libXt:location}/lib
+  ${mesa:location}/lib
+  ${pango:location}/lib
+  ${pcre:location}/lib
+  ${pixman:location}/lib
+  ${xdamage:location}/lib
+  ${xfixes:location}/lib
+  ${xz-utils:location}/lib
+  ${zlib:location}/lib
+path =
+  ${fontconfig:location}/bin
 
-version = 51.0.1
+script =
+  url, md5sum = self.options[guessPlatform()].split()
+  extract_dir = self.extract(self.download(url, md5sum))
+  self.copyTree(guessworkdir(extract_dir), %(location)r)
 
-x86 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-i686/en-US/firefox-${:version}.tar.bz2 9a5b67e9d759a1e4df004294a24b2b43
-x86-64 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-x86_64/en-US/firefox-${:version}.tar.bz2 bd93f2652d1d90d59ae462439a93c85f
-geckodriver_x86 = https://github.com/mozilla/geckodriver/releases/download/v0.14.0/geckodriver-v0.14.0-linux32.tar.gz b5836f5a944fe9f3ed1a67c7b342c6a7
-geckodriver_x86-64 = https://github.com/mozilla/geckodriver/releases/download/v0.14.0/geckodriver-v0.14.0-linux64.tar.gz 4a185d3179862a35104603b9274452e7
 
-script =
-  if not self.options.get('url'): self.options['url'], self.options['md5sum'] = self.options[guessPlatform()].split(' ')
-  extract_dir = self.extract(self.download(self.options['url'], self.options.get('md5sum')))
-  workdir = guessworkdir(extract_dir)
-  self.copyTree(workdir, "%(location)s")
-  geckodriver_url, geckodriver_md5sum = self.options['geckodriver_' + guessPlatform()].split(' ')
-  extract_dir = self.extract(self.download(geckodriver_url, geckodriver_md5sum))
-  shutil.copy(extract_dir + '/geckodriver', "%(location)s")
-  wrapper_location = os.path.join("%(location)s", "firefox-slapos")
-  wrapper = open(wrapper_location, 'w')
-  wrapper.write("""#!${dash:location}/bin/dash
-  cd %(location)s
-  export LD_LIBRARY_PATH="%(location)s"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${alsa:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${atk:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${at-spi2-atk:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${at-spi2-core:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${bzip2:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${cairo:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${dbus:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${dbus-glib:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${fontconfig:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${freetype:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gdk-pixbuf:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gettext:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${glib:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gtk-3:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${harfbuzz:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libepoxy:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libffi:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libICE:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libpng:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libSM:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libtool:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libuuid:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libX11:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXau:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libxcb:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXcomposite:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXcursor:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXext:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXi:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libxml2:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXrender:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXt:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${mesa:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${pango:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${pcre:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${pixman:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${xdamage:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${xfixes:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${xz-utils:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${zlib:location}/lib"
-  export PATH=${fontconfig:location}/bin:$PATH
-  exec %(location)s/firefox "$@" 2> /dev/null
-  """)
-  wrapper.close()
-  os.chmod(wrapper_location, 0755)
-
-[firefox-45]
-recipe = slapos.recipe.build
-slapos_promise =
-  file:firefox
-  file:firefox-bin
+[geckodriver]
+# Current geckodriver installed as buildout:bin-directory/geckodriver
+<= geckodriver-0.14.0
 
-depends =
-  ${liberation-fonts:location}
-  ${ipaex-fonts:location}
+[geckodriver-0.14.0]
+<= geckodriver-base
+version = 0.14.0
+i686-md5sum = b5836f5a944fe9f3ed1a67c7b342c6a7
+x86_64-md5sum = 4a185d3179862a35104603b9274452e7
 
-version = 45.0.1
 
-# MD5SUMs are available at :
-# https://ftp.mozilla.org/pub/mozilla.org/firefox/releases/${:version}/MD5SUMS
-x86 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-i686/en-US/firefox-${:version}.tar.bz2 3756c8d06d6f915a3dff1dae643ee74b
-x86-64 = http://download-installer.cdn.mozilla.net/pub/firefox/releases/${:version}/linux-x86_64/en-US/firefox-${:version}.tar.bz2 0409177ef649ec90ffe7a421a19bc156
+[geckodriver-base]
+# Installs geckodriver ${version}
+recipe = slapos.recipe.build
+location = ${buildout:bin-directory}/${:_buildout_section_name_}
+
+x86 = https://github.com/mozilla/geckodriver/releases/download/v${:version}/geckodriver-v${:version}-linux32.tar.gz ${:i686-md5sum}
+x86-64 = https://github.com/mozilla/geckodriver/releases/download/v${:version}/geckodriver-v${:version}-linux64.tar.gz ${:x86_64-md5sum}
 
 script =
-  if not self.options.get('url'): self.options['url'], self.options['md5sum'] = self.options[guessPlatform()].split(' ')
-  extract_dir = self.extract(self.download(self.options['url'], self.options.get('md5sum')))
-  workdir = guessworkdir(extract_dir)
-  self.copyTree(workdir, "%(location)s")
-  wrapper_location = os.path.join("%(location)s", "firefox-slapos")
-  wrapper = open(wrapper_location, 'w')
-  wrapper.write("""#!${dash:location}/bin/dash
-  cd %(location)s
-  export LD_LIBRARY_PATH="%(location)s"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${alsa:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${atk:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${bzip2:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${cairo:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${dbus:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${dbus-glib:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${fontconfig:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${freetype:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gdk-pixbuf:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gettext:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${glib:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${gtk-2:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${harfbuzz:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libICE:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libSM:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libX11:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXau:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXcomposite:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXcursor:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXext:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXrender:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libXt:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libffi:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libpng:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libtool:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libuuid:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libxcb:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${libxml2:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${p11-kit:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${pango:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${pixman:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${xdamage:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${xfixes:location}/lib"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${zlib:location}/lib"
-  export PATH=${fontconfig:location}/bin:$PATH
-  exec %(location)s/firefox $*""")
-  wrapper.close()
-  os.chmod(wrapper_location, 0755)
+  url, md5sum = self.options[guessPlatform()].split()
+  extract_dir = self.extract(self.download(url, md5sum))
+  shutil.copy(extract_dir + '/geckodriver', %(location)r)

software/jstestnode/buildout.hash.cfg

@@ -27,4 +27,4 @@ md5sum = 9f22db89a2679534aa8fd37dbca86782
 
 [template-runTestSuite]
 filename = runTestSuite.in
-md5sum = 2898d62902351e6df9ce887bd98e2ca1
+md5sum = af6985e2192b43b5b1dfd37bb538df72

software/jstestnode/runTestSuite.in

@@ -94,8 +94,8 @@ def main():
       firefox_capabilities = webdriver.common.desired_capabilities.DesiredCapabilities.FIREFOX
       firefox_capabilities['marionette'] = True
       browser = webdriver.Firefox(capabilities=firefox_capabilities,
-                                  firefox_binary='${firefox:location}/firefox-slapos',
-                                  executable_path='${firefox:location}/geckodriver')
+                                  firefox_binary='${firefox-wrapper:location}',
+                                  executable_path='${geckodriver:location}')
     elif args.target in ['iOS', 'Android']:
       # parameters for mobile emulators have different names then parameters for
       # desktop OSes

software/seleniumrunner/buildout.hash.cfg

@@ -19,4 +19,4 @@ md5sum = c4ac5de141ae6a64848309af03e51d88
 
 [template-selenium]
 filename = instance-selenium.cfg.in
-md5sum = 8be91f4515decef0f8af5910e43e0e52
+md5sum = 9b6648b8f37baa3f7a6bfb68d4426049

software/seleniumrunner/instance-selenium.cfg.in

@@ -17,7 +17,7 @@ report-project = $${slap-parameter:report-project}
 [firefox-instance]
 recipe = slapos.cookbook:firefox
 runner-path = $${rootdirectory:bin}/firefox-sandboxed
-firefox-path = ${firefox:location}/firefox-slapos
+firefox-path = ${firefox-wrapper:location}
 prefsjs-path = $${rootdirectory:etc}/prefs.js
 shell-path = ${dash:location}/bin/dash
 tmp-path = $${xvfb-instance:tmp-path}

software/seleniumrunner/software.cfg

@@ -16,6 +16,7 @@ parts =
    instance-recipe-egg
    xserver
    firefox
+   geckodriver
    xwd
 
 [instance-recipe]