Merge branch 'master' into fix_#938

Author: katie-knister

completions/bash/multipass

@@ -1,4 +1,4 @@
-# Copyright © 2017-2019 Canonical Ltd.
+# Copyright © 2017-2020 Canonical Ltd.
 #
 # 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
@@ -46,8 +46,8 @@ _multipass_complete()
     prev="${COMP_WORDS[COMP_CWORD-1]}"
     cmd="${COMP_WORDS[1]}"
     prev_opts=false
-    multipass_cmds="transfer delete exec find help info launch list mount purge \
-                    recover shell start stop suspend restart umount version get set"
+    multipass_cmds="transfer delete exec find help info launch list list-networks mount \
+                    purge recover shell start stop suspend restart umount version get set"
 
     opts="--help --verbose"
     case "${cmd}" in
@@ -57,11 +57,14 @@ _multipass_complete()
         "list"|"ls")
             opts="${opts} --format"
         ;;
+        "list-networks"|"ln")
+            opts="${opts} --format"
+        ;;
         "delete")
             opts="${opts} --all --purge"
         ;;
         "launch")
-            opts="${opts} --cpus --disk --mem --name --cloud-init"
+            opts="${opts} --cpus --disk --mem --name --cloud-init --network"
         ;;
         "mount")
             opts="${opts} --gid-map --uid-map"
@@ -87,6 +90,7 @@ _multipass_complete()
                 _filedir
                 return
             ;;
+            # TODO: add "--network" here
         esac
     fi
 

include/multipass/cli/csv_formatter.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 Canonical, Ltd.
+ * Copyright (C) 2018-2020 Canonical, Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,6 +27,7 @@ class CSVFormatter final : public Formatter
 public:
     std::string format(const InfoReply& info) const override;
     std::string format(const ListReply& list) const override;
+    std::string format(const ListNetworksReply& list) const override;
     std::string format(const FindReply& list) const override;
 };
 }

include/multipass/cli/formatter.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 Canonical, Ltd.
+ * Copyright (C) 2018-2020 Canonical, Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -34,6 +34,7 @@ class Formatter
     virtual ~Formatter() = default;
     virtual std::string format(const InfoReply& reply) const = 0;
     virtual std::string format(const ListReply& reply) const = 0;
+    virtual std::string format(const ListNetworksReply& reply) const = 0;
     virtual std::string format(const FindReply& reply) const = 0;
 
 protected:

include/multipass/cli/json_formatter.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 Canonical, Ltd.
+ * Copyright (C) 2018-2020 Canonical, Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,6 +27,7 @@ class JsonFormatter final : public Formatter
 public:
     std::string format(const InfoReply& info) const override;
     std::string format(const ListReply& list) const override;
+    std::string format(const ListNetworksReply& list) const override;
     std::string format(const FindReply& list) const override;
 };
 }

include/multipass/cli/table_formatter.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 Canonical, Ltd.
+ * Copyright (C) 2018-2020 Canonical, Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,6 +27,7 @@ class TableFormatter final : public Formatter
 public:
     std::string format(const InfoReply& info) const override;
     std::string format(const ListReply& list) const override;
+    std::string format(const ListNetworksReply& list) const override;
     std::string format(const FindReply& list) const override;
 };
 }

include/multipass/cli/yaml_formatter.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2018 Canonical, Ltd.
+ * Copyright (C) 2018-2020 Canonical, Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -27,6 +27,7 @@ class YamlFormatter final : public Formatter
 public:
     std::string format(const InfoReply& info) const override;
     std::string format(const ListReply& list) const override;
+    std::string format(const ListNetworksReply& list) const override;
     std::string format(const FindReply& list) const override;
 };
 }

include/multipass/exceptions/not_implemented_on_this_backend_exception.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2020 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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/>.
+ *
+ */
+
+#ifndef MULTIPASS_NOT_IMPLEMENTED_ON_THIS_BACKEND_EXCEPTION_H
+#define MULTIPASS_NOT_IMPLEMENTED_ON_THIS_BACKEND_EXCEPTION_H
+
+#include <stdexcept>
+
+#include <multipass/format.h>
+
+namespace multipass
+{
+class NotImplementedOnThisBackendException : public std::runtime_error
+{
+public:
+    NotImplementedOnThisBackendException(const std::string& feature)
+        : runtime_error(fmt::format("The {} feature is not implemented on this backend.", feature))
+    {
+    }
+};
+} // namespace multipass
+
+#endif // MULTIPASS_NOT_IMPLEMENTED_ON_THIS_BACKEND_EXCEPTION_H

include/multipass/network_interface.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2020 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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/>.
+ *
+ */
+
+#ifndef MULTIPASS_NETWORK_INTERFACE_H
+#define MULTIPASS_NETWORK_INTERFACE_H
+
+#include <string>
+
+namespace multipass
+{
+struct NetworkInterface
+{
+    std::string id;
+    std::string mac_address;
+    bool auto_mode;
+};
+} // namespace multipass
+
+#endif // MULTIPASS_NETWORK_INTERFACE_H

include/multipass/network_interface_info.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2020 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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/>.
+ *
+ */
+
+#ifndef MULTIPASS_NETWORK_INTERFACE_INFO_H
+#define MULTIPASS_NETWORK_INTERFACE_INFO_H
+
+#include <multipass/ip_address.h>
+#include <multipass/optional.h>
+
+namespace multipass
+{
+struct NetworkInterfaceInfo
+{
+    std::string id;
+    std::string type;
+    std::string description;
+};
+} // namespace multipass
+#endif // MULTIPASS_NETWORK_INTERFACE_INFO_H

include/multipass/platform.h

@@ -20,6 +20,7 @@
 
 #include <multipass/days.h>
 #include <multipass/logging/logger.h>
+#include <multipass/network_interface_info.h>
 #include <multipass/process/process.h>
 #include <multipass/process/process_spec.h>
 #include <multipass/sshfs_server_config.h>
@@ -70,6 +71,11 @@ bool is_remote_supported(const std::string& remote);
 bool is_image_url_supported();
 
 std::function<int()> make_quit_watchdog(); // call while single-threaded; call result later, in dedicated thread
+
+// Get information on the network interfaces that are seen by the platform, indexed by name
+std::map<std::string, NetworkInterfaceInfo> get_network_interfaces_info();
+std::string reinterpret_interface_id(const std::string& ux_id); // give platforms a chance to reinterpret network IDs
+
 } // namespace platform
 } // namespace multipass
 #endif // MULTIPASS_PLATFORM_H