🧹 Add shutdown to v9 plugins (#1632)

This allows us to call clean-up funcs, when we close the connection.

Fixes #1628

---------

Signed-off-by: Christian Zunker <[email protected]>

apps/provider-scaffold/template/provider/provider.go.template

@@ -69,6 +69,13 @@ func (s *Service) Connect(req *plugin.ConnectReq, callback plugin.ProviderCallba
 	}, nil
 }
 
+// Shutdown is automatically called when the shell closes.
+// It is not necessary to implement this method.
+// If you want to do some cleanup, you can do it here.
+func (s *Service) Shutdown(req *plugin.ShutdownReq) (*plugin.ShutdownRes, error) {
+	return &plugin.ShutdownRes{}, nil
+}
+
 func (s *Service) connect(req *plugin.ConnectReq, callback plugin.ProviderCallback) (*connection.{{ .CamelcaseProviderID }}Connection, error) {
 	if len(req.Asset.Connections) == 0 {
 		return nil, errors.New("no connection options for asset")

cli/providers/providers.go

@@ -276,6 +276,7 @@ func setConnector(provider *plugin.Provider, connector *plugin.Connector, run fu
 			}
 		}
 
+		// TODO: add flag to set timeout and then use RuntimeWithShutdownTimeout
 		runtime := providers.Coordinator.NewRuntime()
 
 		// TODO: read from config

providers-sdk/v1/plugin/grpc.go

@@ -50,6 +50,10 @@ func (m *GRPCClient) Connect(req *ConnectReq, callback ProviderCallback) (*Conne
 	return res, err
 }
 
+func (m *GRPCClient) Shutdown(req *ShutdownReq) (*ShutdownRes, error) {
+	return m.client.Shutdown(context.Background(), req)
+}
+
 func (m *GRPCClient) GetData(req *DataReq) (*DataRes, error) {
 	return m.client.GetData(context.Background(), req)
 }

providers-sdk/v1/plugin/interface.go

@@ -32,6 +32,7 @@ type ProviderCallback interface {
 type ProviderPlugin interface {
 	ParseCLI(req *ParseCLIReq) (*ParseCLIRes, error)
 	Connect(req *ConnectReq, callback ProviderCallback) (*ConnectRes, error)
+	Shutdown(req *ShutdownReq) (*ShutdownRes, error)
 	GetData(req *DataReq) (*DataRes, error)
 	StoreData(req *StoreReq) (*StoreRes, error)
 }

providers-sdk/v1/plugin/plugin.proto

@@ -38,6 +38,12 @@ message ConnectRes {
   Inventory inventory = 4;
 }
 
+message ShutdownReq {
+}
+
+message ShutdownRes {
+}
+
 message DataReq {
   uint32 connection = 1;
   string resource = 3;
@@ -71,6 +77,7 @@ message StoreRes {}
 service ProviderPlugin {
   rpc ParseCLI(ParseCLIReq) returns (ParseCLIRes);
   rpc Connect(ConnectReq) returns (ConnectRes);
+  rpc Shutdown(ShutdownReq) returns (ShutdownRes);
   rpc GetData(DataReq) returns (DataRes);
   rpc StoreData(StoreReq) returns (StoreRes);
 }

providers/arista/provider/provider.go

@@ -109,6 +109,13 @@ func (s *Service) Connect(req *plugin.ConnectReq, callback plugin.ProviderCallba
 	}, nil
 }
 
+// Shutdown is automatically called when the shell closes.
+// It is not necessary to implement this method.
+// If you want to do some cleanup, you can do it here.
+func (s *Service) Shutdown(req *plugin.ShutdownReq) (*plugin.ShutdownRes, error) {
+	return &plugin.ShutdownRes{}, nil
+}
+
 func (s *Service) connect(req *plugin.ConnectReq, callback plugin.ProviderCallback) (*connection.AristaConnection, error) {
 	if len(req.Asset.Connections) == 0 {
 		return nil, errors.New("no connection options for asset")

providers/arista/resources/arista.lr.manifest.yaml

@@ -49,6 +49,7 @@ resources:
       name: {}
       physicalAddress: {}
       status: {}
+    is_private: true
     min_mondoo_version: 5.15.0
     platform:
       name:
@@ -58,6 +59,7 @@ resources:
       address: {}
       mtu: {}
       name: {}
+    is_private: true
     min_mondoo_version: 5.15.0
     platform:
       name:
@@ -74,6 +76,7 @@ resources:
       default: {}
       name: {}
       rules: {}
+    is_private: true
     min_mondoo_version: 5.15.0
     platform:
       name:

providers/aws/provider/provider.go

@@ -153,6 +153,13 @@ func (s *Service) detect(asset *inventory.Asset, conn *connection.AwsConnection)
 	return nil
 }
 
+// Shutdown is automatically called when the shell closes.
+// It is not necessary to implement this method.
+// If you want to do some cleanup, you can do it here.
+func (s *Service) Shutdown(req *plugin.ShutdownReq) (*plugin.ShutdownRes, error) {
+	return &plugin.ShutdownRes{}, nil
+}
+
 func (s *Service) GetData(req *plugin.DataReq) (*plugin.DataRes, error) {
 	runtime, ok := s.runtimes[req.Connection]
 	if !ok {

providers/azure/provider/provider.go

@@ -131,6 +131,13 @@ func (s *Service) Connect(req *plugin.ConnectReq, callback plugin.ProviderCallba
 	}, nil
 }
 
+// Shutdown is automatically called when the shell closes.
+// It is not necessary to implement this method.
+// If you want to do some cleanup, you can do it here.
+func (s *Service) Shutdown(req *plugin.ShutdownReq) (*plugin.ShutdownRes, error) {
+	return &plugin.ShutdownRes{}, nil
+}
+
 func (s *Service) connect(req *plugin.ConnectReq, callback plugin.ProviderCallback) (*connection.AzureConnection, error) {
 	if len(req.Asset.Connections) == 0 {
 		return nil, errors.New("no connection options for asset")

providers/azure/resources/azure.lr.manifest.yaml

@@ -154,6 +154,7 @@ resources:
       name: {}
       osDisk: {}
       properties: {}
+      publicIpAddresses: {}
       tags: {}
       type: {}
     min_mondoo_version: latest

providers/core/provider/provider.go

@@ -69,6 +69,13 @@ func (s *Service) Connect(req *plugin.ConnectReq, callback plugin.ProviderCallba
 	}, nil
 }
 
+// Shutdown is automatically called when the shell closes.
+// It is not necessary to implement this method.
+// If you want to do some cleanup, you can do it here.
+func (s *Service) Shutdown(req *plugin.ShutdownReq) (*plugin.ShutdownRes, error) {
+	return &plugin.ShutdownRes{}, nil
+}
+
 func (s *Service) GetData(req *plugin.DataReq) (*plugin.DataRes, error) {
 	runtime, ok := s.runtimes[req.Connection]
 	if !ok {

providers/core/resources/core.lr.manifest.yaml

@@ -4,18 +4,18 @@
 resources:
   asset:
     fields:
-      name: {}
-      ids: {}
-      platform: {}
-      kind: {}
-      runtime: {}
-      version: {}
       arch: {}
-      title: {}
+      build: {}
       family: {}
       fqdn: {}
-      build: {}
+      ids: {}
+      kind: {}
       labels: {}
+      name: {}
+      platform: {}
+      runtime: {}
+      title: {}
+      version: {}
       vulnerabilityReport: {}
     min_mondoo_version: 6.13.0
   audit.advisory:
@@ -27,7 +27,6 @@ resources:
       published: {}
       title: {}
       worstScore: {}
-    is_private: true
     min_mondoo_version: 5.15.0
   audit.cve:
     fields:
@@ -39,21 +38,18 @@ resources:
       summary: {}
       unscored: {}
       worstScore: {}
-    is_private: true
     min_mondoo_version: 5.15.0
   audit.cvss:
     fields:
       score: {}
       vector: {}
-    is_private: true
     min_mondoo_version: 5.15.0
   audit.exploit:
     fields:
       id: {}
       modified: {}
       mrn: {}
       worstScore: {}
-    is_private: true
     min_mondoo_version: 5.15.0
   authorizedkeys:
     fields:
@@ -146,6 +142,8 @@ resources:
     min_mondoo_version: 5.15.0
   mondoo:
     fields:
+      arch:
+        min_mondoo_version: latest
       build: {}
       capabilities: {}
       jobEnvironment: {}