diff options
| author | John Estabrook <jestabro@vyos.io> | 2022-05-16 16:16:59 -0500 | 
|---|---|---|
| committer | John Estabrook <jestabro@vyos.io> | 2022-07-24 08:44:58 -0500 | 
| commit | f9bd803ffe8ae5b8b353bf53c4c7471323935e24 (patch) | |
| tree | f58a004a52a5059fab4424f96c817a25f313b617 /src | |
| parent | b882e997e18c0d63aa7a4507df9b71c81c1970d1 (diff) | |
| download | vyos-1x-f9bd803ffe8ae5b8b353bf53c4c7471323935e24.tar.gz vyos-1x-f9bd803ffe8ae5b8b353bf53c4c7471323935e24.zip | |
graphql: T4413: add support for a system status query
Diffstat (limited to 'src')
7 files changed, 94 insertions, 1 deletions
| diff --git a/src/services/api/graphql/graphql/directives.py b/src/services/api/graphql/graphql/directives.py index 0a9298f55..551d28831 100644 --- a/src/services/api/graphql/graphql/directives.py +++ b/src/services/api/graphql/graphql/directives.py @@ -48,6 +48,14 @@ class ShowConfigDirective(VyosDirective):          super().visit_field_definition(field, object_type,                                         make_resolver=make_show_config_resolver) +class SystemStatusDirective(VyosDirective): +    """ +    Class providing implementation of 'system_status' directive in schema. +    """ +    def visit_field_definition(self, field, object_type): +        super().visit_field_definition(field, object_type, +                                       make_resolver=make_system_status_resolver) +  class ConfigFileDirective(VyosDirective):      """      Class providing implementation of 'configfile' directive in schema. @@ -74,6 +82,7 @@ class ImageDirective(VyosDirective):  directives_dict = {"configure": ConfigureDirective,                     "showconfig": ShowConfigDirective, +                   "systemstatus": SystemStatusDirective,                     "configfile": ConfigFileDirective,                     "show": ShowDirective,                     "image": ImageDirective} diff --git a/src/services/api/graphql/graphql/queries.py b/src/services/api/graphql/graphql/queries.py index ed94e4338..eeaa9e19c 100644 --- a/src/services/api/graphql/graphql/queries.py +++ b/src/services/api/graphql/graphql/queries.py @@ -94,6 +94,10 @@ def make_show_config_resolver(query_name):      class_name = query_name      return make_query_resolver(query_name, class_name, 'show_config') +def make_system_status_resolver(query_name): +    class_name = query_name +    return make_query_resolver(query_name, class_name, 'system_status') +  def make_show_resolver(query_name):      class_name = query_name      return make_query_resolver(query_name, class_name, 'show') diff --git a/src/services/api/graphql/graphql/schema/schema.graphql b/src/services/api/graphql/graphql/schema/schema.graphql index 952e46f34..8ae71f632 100644 --- a/src/services/api/graphql/graphql/schema/schema.graphql +++ b/src/services/api/graphql/graphql/schema/schema.graphql @@ -7,11 +7,15 @@ directive @configure on FIELD_DEFINITION  directive @configfile on FIELD_DEFINITION  directive @show on FIELD_DEFINITION  directive @showconfig on FIELD_DEFINITION +directive @systemstatus on FIELD_DEFINITION  directive @image on FIELD_DEFINITION +scalar Generic +  type Query {      Show(data: ShowInput) : ShowResult @show      ShowConfig(data: ShowConfigInput) : ShowConfigResult @showconfig +    SystemStatus(data: SystemStatusInput) : SystemStatusResult @systemstatus  }  type Mutation { diff --git a/src/services/api/graphql/graphql/schema/show_config.graphql b/src/services/api/graphql/graphql/schema/show_config.graphql index fd54036a4..5a1fe43da 100644 --- a/src/services/api/graphql/graphql/schema/show_config.graphql +++ b/src/services/api/graphql/graphql/schema/show_config.graphql @@ -2,7 +2,6 @@  Use 'scalar Generic' for show config output, to avoid attempts to  JSON-serialize in case of JSON output.  """ -scalar Generic  input ShowConfigInput {      key: String! diff --git a/src/services/api/graphql/graphql/schema/system_status.graphql b/src/services/api/graphql/graphql/schema/system_status.graphql new file mode 100644 index 000000000..be8d87535 --- /dev/null +++ b/src/services/api/graphql/graphql/schema/system_status.graphql @@ -0,0 +1,18 @@ +""" +Use 'scalar Generic' for system status output, to avoid attempts to +JSON-serialize in case of JSON output. +""" + +input SystemStatusInput { +    key: String! +} + +type SystemStatus { +    result: Generic +} + +type SystemStatusResult { +    data: SystemStatus +    success: Boolean! +    errors: [String] +} diff --git a/src/services/api/graphql/recipes/queries/system_status.py b/src/services/api/graphql/recipes/queries/system_status.py new file mode 100755 index 000000000..4a4d9871c --- /dev/null +++ b/src/services/api/graphql/recipes/queries/system_status.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2022 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later 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/>. +# +# + +import os +import sys +import json +import importlib.util + +from vyos.defaults import directories + +OP_PATH = directories['op_mode'] + +def load_as_module(name: str): +    path = os.path.join(OP_PATH, name) +    spec = importlib.util.spec_from_file_location(name, path) +    mod = importlib.util.module_from_spec(spec) +    spec.loader.exec_module(mod) +    return mod + +def get_system_version() -> dict: +    show_version = load_as_module('show_version.py') +    return show_version.get_raw_data() + +def get_system_uptime() -> dict: +    show_uptime = load_as_module('show_uptime.py') +    return show_uptime.get_raw_data() + +def get_system_ram_usage() -> dict: +    show_ram = load_as_module('show_ram.py') +    return show_ram.get_raw_data() diff --git a/src/services/api/graphql/recipes/session.py b/src/services/api/graphql/recipes/session.py index 1f844ff70..c436de08a 100644 --- a/src/services/api/graphql/recipes/session.py +++ b/src/services/api/graphql/recipes/session.py @@ -136,3 +136,17 @@ class Session:              raise error          return res + +    def system_status(self): +        import api.graphql.recipes.queries.system_status as system_status + +        session = self._session +        data = self._data + +        status = {} +        status['host_name'] = session.show(['host', 'name']).strip() +        status['version'] = system_status.get_system_version() +        status['uptime'] = system_status.get_system_uptime() +        status['ram'] = system_status.get_system_ram_usage() + +        return status | 
