Merge pull request #607 from powerapi-ng/refactor/remove-virtiofs-database

refactor(database): Remove unused `virtiofs` database

Author: gfieni

src/powerapi/cli/common_cli_parsing_manager.py

@@ -159,41 +159,6 @@ def __init__(self):
             subgroup_parser=subparser_csv_input
         )
 
-        subparser_virtiofs_output = SubgroupConfigParsingManager("virtiofs")
-        help_text = "regexp used to extract vm name from report."
-        help_text += "The regexp must match the name of the target in the HWPC-report and a group must"
-        subparser_virtiofs_output.add_argument("r", "vm_name_regexp", help_text=help_text)
-        subparser_virtiofs_output.add_argument(
-            "d",
-            "root_directory_name",
-            help_text="directory where VM directory will be stored",
-        )
-        subparser_virtiofs_output.add_argument(
-            "p",
-            "vm-directory-name-prefix",
-            help_text="first part of the VM directory name",
-            default_value="",
-        )
-        subparser_virtiofs_output.add_argument(
-            "s",
-            "vm-directory-name-suffix",
-            help_text="last part of the VM directory name",
-            default_value="",
-        )
-        subparser_virtiofs_output.add_argument(
-            "m",
-            "model",
-            help_text="specify data type that will be stored in the database",
-            default_value="PowerReport",
-        )
-        subparser_virtiofs_output.add_argument(
-            "n", "name", help_text="specify pusher name", default_value="pusher_virtiofs"
-        )
-        self.add_subgroup_parser(
-            subgroup_name="output",
-            subgroup_parser=subparser_virtiofs_output
-        )
-
         subparser_mongo_output = SubgroupConfigParsingManager("mongodb")
         subparser_mongo_output.add_argument("u", "uri", help_text="specify MongoDB uri")
         subparser_mongo_output.add_argument(

src/powerapi/cli/generator.py

@@ -33,7 +33,7 @@
 from collections.abc import Callable
 
 from powerapi.actor import Actor
-from powerapi.database import MongoDB, CsvDB, OpenTSDB, SocketDB, PrometheusDB, VirtioFSDB
+from powerapi.database import MongoDB, CsvDB, OpenTSDB, SocketDB, PrometheusDB
 from powerapi.database.influxdb2 import InfluxDB2
 from powerapi.exception import PowerAPIException, ModelNameAlreadyUsed, DatabaseNameDoesNotExist, ModelNameDoesNotExist, \
     DatabaseNameAlreadyUsed, ProcessorTypeDoesNotExist, ProcessorTypeAlreadyUsed
@@ -189,11 +189,6 @@ def __init__(self, component_group_name: str):
                                                          metric_name=db_config['metric-name'],
                                                          metric_description=db_config['metric-description'],
                                                          tags=gen_tag_list(db_config)),
-            'virtiofs': lambda db_config: VirtioFSDB(report_type=db_config['model'],
-                                                     vm_name_regexp=db_config['vm-name-regexp'],
-                                                     root_directory_name=db_config['root-directory-name'],
-                                                     vm_directory_name_prefix=db_config['vm-directory-name-prefix'],
-                                                     vm_directory_name_suffix=db_config['vm-directory-name-suffix']),
         }
 
     def remove_report_class(self, model_name: str):

src/powerapi/database/__init__.py

@@ -26,11 +26,11 @@
 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 from powerapi.database.base_db import BaseDB, IterDB, DBError
 from powerapi.database.csv import CsvDB
 from powerapi.database.mongodb import MongoDB
 from powerapi.database.opentsdb import OpenTSDB
 from powerapi.database.influxdb2 import InfluxDB2
 from powerapi.database.prometheus import PrometheusDB
-from powerapi.database.virtiofs import VirtioFSDB
 from powerapi.database.socket import SocketDB

src/powerapi/database/virtiofs/__init__.py

@@ -159,22 +159,6 @@ def several_inputs_outputs_stream_opentsdb_without_some_arguments_config(several
     return several_inputs_outputs_stream_config
 
 
-@pytest.fixture
-def several_inputs_outputs_stream_virtiofs_without_some_arguments_config(several_inputs_outputs_stream_config):
-    """
-    Configuration with several inputs and outputs and stream mode enabled. Some arguments
-    of virtiofs output are removed
-    """
-    for _, current_output in several_inputs_outputs_stream_config["output"].items():
-        if current_output['type'] == 'virtiofs':
-            current_output.pop('vm-name-regexp')
-            current_output.pop('root-directory-name')
-            current_output.pop('vm-directory-name-prefix')
-            current_output.pop('vm-directory-name-suffix')
-
-    return several_inputs_outputs_stream_config
-
-
 @pytest.fixture
 def several_k8s_pre_processors_config():
     """

src/powerapi/database/virtiofs/virtiofs_db.py

@@ -280,12 +280,6 @@ def test_generate_several_pushers_from_config(several_inputs_outputs_stream_conf
             assert db.host == current_pusher_infos['uri']
             assert db.metric_name == current_pusher_infos['metric-name']
 
-        elif pusher_type == 'virtiofs':
-            assert db.vm_name_regexp == compile(current_pusher_infos['vm-name-regexp'])
-            assert db.root_directory_name == current_pusher_infos['root-directory-name']
-            assert db.vm_directory_name_prefix == current_pusher_infos['vm-directory-name-prefix']
-            assert db.vm_directory_name_suffix == current_pusher_infos['vm-directory-name-suffix']
-
         else:
             pytest.fail(f'Unsupported pusher type: {pusher_type}')
 
@@ -323,17 +317,6 @@ def test_generate_pusher_raise_exception_when_missing_arguments_in_opentsdb_outp
         generator.generate(several_inputs_outputs_stream_opentsdb_without_some_arguments_config)
 
 
-def test_generate_pusher_raise_exception_when_missing_arguments_in_virtiofs_output(
-        several_inputs_outputs_stream_virtiofs_without_some_arguments_config):
-    """
-    Test that PusherGenerator raises a PowerAPIException when some arguments are missing for virtiofs output
-    """
-    generator = PusherGenerator()
-
-    with pytest.raises(PowerAPIException):
-        generator.generate(several_inputs_outputs_stream_virtiofs_without_some_arguments_config)
-
-
 def test_generate_pusher_when_missing_arguments_in_csv_output_generate_related_actors(
         several_inputs_outputs_stream_csv_without_some_arguments_config):
     """

tests/unit/cli/conftest.py

@@ -62,14 +62,6 @@
           "uri": "127.0.0.1",
           "port": 1111,
           "metric-name": "my metric opentsdb"
-      },
-      "seventh": {
-          "type": "virtiofs",
-          "model": "PowerReport",
-          "vm-name-regexp": "vm_name$",
-          "root-directory-name": "my_dir",
-          "vm-directory-name-prefix": "prefix_1",
-          "vm-directory-name-suffix": "suffix_1"
       }
   }
 }