pluginhandler: build scriptlet support (canonical#988)

LP: #1642371

Signed-off-by: Sergio Schvezov <[email protected]>

.vscode/launch.json

@@ -0,0 +1,33 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python",
+            "type": "python",
+            "request": "launch",
+            "stopOnEntry": true,
+            "pythonPath": "${config.python.pythonPath}",
+            "program": "${file}",
+            "cwd": "${workspaceRoot}",
+            "debugOptions": [
+                "WaitOnAbnormalExit",
+                "WaitOnNormalExit",
+                "RedirectOutput"
+            ]
+        },
+        {
+            "name": "Unit Test",
+            "type": "python",
+            "request": "launch",
+            "stopOnEntry": false,
+            "pythonPath": "${config.python.pythonPath}",
+            "program": "${workspaceRoot}/units.py",
+            "cwd": "${workspaceRoot}",
+            "debugOptions": [
+                "WaitOnAbnormalExit",
+                "WaitOnNormalExit",
+                "RedirectOutput"
+            ]
+        }
+    ]
+}

integration_tests/snaps/scriptlet-build/Makefile

@@ -0,0 +1,7 @@
+# -*- Mode: Makefile; indent-tabs-mode:t; tab-width: 4 -*-
+
+build:
+	touch build-build
+
+move-to-dest:
+	touch $(DESTDIR)/build-install

integration_tests/snaps/scriptlet-build/snapcraft.yaml

@@ -0,0 +1,17 @@
+name: build-scriptlet-test
+version: '0.1'
+summary: Runs the build scriptlet for a part
+description: |
+  Runs the shell script defined in `build` overriding the plugins
+  build directives.
+
+grade: devel
+confinement: devmode
+
+parts:
+  build-scriptlet-test:
+    source: .
+    plugin: make
+    build: |
+      make build
+      make move-to-dest DESTDIR=$SNAPCRAFT_PART_INSTALL

integration_tests/test_scriptlets.py

@@ -29,16 +29,21 @@ def test_prepare_scriptlet(self):
 
         installdir = os.path.join(
             project_dir, 'parts', 'prepare-scriptlet-test', 'install')
-        prepared_file_path = os.path.join(installdir, 'prepared')
+        touch_file_path = os.path.join(installdir, 'prepared')
+        self.assertThat(touch_file_path, FileExists())
 
-        installdir = os.path.join(
-            project_dir, 'parts', 'prepare-and-install', 'install')
-        built_file_path = os.path.join(installdir, 'built')
-        installed_file_path = os.path.join(installdir, 'installed')
+    def test_build_scriptlet(self):
+        project_dir = 'scriptlet-build'
+        self.run_snapcraft('build', project_dir)
 
-        self.assertThat(prepared_file_path, FileExists())
-        self.assertThat(built_file_path, FileExists())
-        self.assertThat(installed_file_path, FileExists())
+        partdir = os.path.join(project_dir, 'parts', 'build-scriptlet-test')
+        builddir = os.path.join(partdir, 'build')
+        installdir = os.path.join(partdir, 'install')
+
+        touch_file_path = os.path.join(builddir, 'build-build')
+        self.assertThat(touch_file_path, FileExists())
+        touch_file_path = os.path.join(installdir, 'build-install')
+        self.assertThat(touch_file_path, FileExists())
 
     def test_install_scriptlet(self):
         project_dir = 'scriptlet-install'

schema/snapcraft.yaml

@@ -210,6 +210,9 @@ properties:
           install:
             type: string
             default: ''
+          build:
+            type: string
+            default: ''
           prepare:
             type: string
             default: ''

snapcraft/__init__.py

@@ -237,6 +237,20 @@
         cd scripts
         ./bootstrap.sh
 
+  - build: shell script
+
+    If present, the shell script defined here is run instead of the `build`
+    step of the plugin. The working directory is the base build directory
+    for the given part. The defined script is run with `/bin/sh`.
+
+    For example:
+
+      plugin: make
+      build: |
+        make project
+        make test
+        make special-install
+
   - install: shell script
 
     If present, the shell script defined here is run after the `build` step

snapcraft/internal/pluginhandler/__init__.py

@@ -390,7 +390,11 @@ def ignore(directory, files):
         script_runner = ScriptRunner(builddir=self.code.build_basedir)
 
         script_runner.run(scriptlet=self._part_properties.get('prepare'))
-        self.code.build()
+        build_scriptlet = self._part_properties.get('build')
+        if build_scriptlet:
+            script_runner.run(scriptlet=build_scriptlet)
+        else:
+            self.code.build()
         script_runner.run(scriptlet=self._part_properties.get('install'))
 
         self.mark_build_done()

units.py

@@ -0,0 +1,4 @@
+import unittest
+
+unittest.main('snapcraft.tests.pluginhandler.test_scriptlets',
+              argv=['ScriptletsTestCase'])  # noqa