Add snappy plugin until PR lands in snapcraft

parts/plugins/x_rust.py

@@ -0,0 +1,134 @@
+# Copyright (C) 2016 Marius Gripsgard ([email protected])
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""This rust plugin is useful for building rust based parts.
+
+Rust uses cargo to drive the build.
+
+This plugin uses the common plugin keywords as well as those for "sources".
+For more information check the 'plugins' topic for the former and the
+'sources' topic for the latter.
+
+Additionally, this plugin uses the following plugin-specific keywords:
+
+    - rust-channel
+      (string)
+      select rust channel (stable, beta, nightly)
+    - rust-revision
+      (string)
+      select rust version
+    - rust-features
+      (list of strings)
+      Features used to build optional dependencies
+"""
+
+import os
+import shutil
+
+import snapcraft
+from snapcraft import sources
+
+_RUSTUP = "https://static.rust-lang.org/rustup.sh"
+
+
+class RustPlugin(snapcraft.BasePlugin):
+    @classmethod
+    def schema(cls):
+        schema = super().schema()
+        schema['properties']['rust-channel'] = {
+            'type': 'string',
+        }
+        schema['properties']['rust-revision'] = {
+            'type': 'string',
+        }
+        schema['properties']['rust-features'] = {
+            'type': 'array',
+            'minitems': 1,
+            'uniqueItems': True,
+            'items': {
+                'type': 'string',
+            },
+            'default': []
+        }
+
+        return schema
+
+    def __init__(self, name, options, project):
+        super().__init__(name, options, project)
+        self.build_packages.extend([
+            'gcc',
+            'binutils',
+            'libc6-dev',
+            'git',
+            'curl',
+            'file',
+        ])
+        self._rustpath = os.path.join(self.partdir, "rust")
+        self._rustc = os.path.join(self._rustpath, "bin", "rustc")
+        self._rustdoc = os.path.join(self._rustpath, "bin", "rustdoc")
+        self._cargo = os.path.join(self._rustpath, "bin", "cargo")
+        self._rustlib = os.path.join(self._rustpath, "lib")
+        self._rustup_get = sources.Script(_RUSTUP, self._rustpath)
+        self._rustup = os.path.join(self._rustpath, "rustup.sh")
+
+    def build(self):
+        super().build()
+        cmd = [self._cargo, "install",
+               "-j{}".format(self.parallel_build_count),
+               "--root", self.installdir]
+        if self.options.rust_features:
+            cmd.append("--features")
+            cmd.append(' '.join(self.options.rust_features))
+        self.run(cmd, env=self._build_env())
+
+    def _build_env(self):
+        env = os.environ.copy()
+        env.update({"RUSTC": self._rustc,
+                    "RUSTDOC": self._rustdoc,
+                    "RUST_PATH": self._rustlib})
+        return env
+
+    def pull(self):
+        super().pull()
+        self._fetch_rust()
+        self._fetch_deps()
+
+    def clean_pull(self):
+        super().clean_pull()
+
+        # Remove the rust path (if any)
+        if os.path.exists(self._rustpath):
+            shutil.rmtree(self._rustpath)
+
+    def _fetch_rust(self):
+        options = []
+
+        if self.options.rust_revision:
+            options.append("--revision=%s" % self.options.rust_revision)
+
+        if self.options.rust_channel:
+            if self.options.rust_channel in ["stable", "beta", "nightly"]:
+                options.append("--channel=%s" % self.options.rust_channel)
+            else:
+                raise EnvironmentError("%s is not a valid rust channel"
+                                       % self.options.rust_channel)
+        if not os.path.exists(self._rustpath):
+            os.makedirs(self._rustpath)
+        self._rustup_get.download()
+        self.run(["%s" % self._rustup,
+                  "--prefix=%s" % self._rustpath,
+                  "--disable-sudo", "--save"])
+
+    def _fetch_deps(self):
+        self.run([self._cargo, "fetch"])