node-scraper rename (#54)

Author: landrews-amd

.github/workflows/unit-test.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Run unit tests with coverage
       id: extract_coverage
       run: |
-        pytest test/unit -s --cov=errorscraper --cov-report=xml --cov-report=term --cov-fail-under=70 --maxfail=1 --disable-warnings -v
+        pytest test/unit -s --cov=nodescraper --cov-report=xml --cov-report=term --cov-fail-under=70 --maxfail=1 --disable-warnings -v
 
     - name: Print coverage
       run: |

README.md

@@ -1,19 +1,19 @@
-# Error Scraper
-Error Scraper is a tool which performs automated data collection and analysis for the purposes of system debug.
+# Node Scraper
+Node Scraper is a tool which performs automated data collection and analysis for the purposes of system debug.
 
 ## Installation
 ### Install From Source
-Error Scraper requires Python 3.10+ for installation. After cloning this repository, call dev-setup.sh script with 'source'. This script creates an editable install of Error Scraper in a python virtual environment and also configures the pre-commit hooks for the project.
+Node Scraper requires Python 3.10+ for installation. After cloning this repository, call dev-setup.sh script with 'source'. This script creates an editable install of Node Scraper in a python virtual environment and also configures the pre-commit hooks for the project.
 
 ```sh
 source dev-setup.sh
 ```
 
 ## CLI Usage
-The Error Scraper CLI can be used to run Error Scraper plugins on a target system. The following CLI options are available:
+The Node Scraper CLI can be used to run Node Scraper plugins on a target system. The following CLI options are available:
 
 ```sh
-usage: error-scraper [-h] [--sys-name STRING] [--sys-location {LOCAL,REMOTE}] [--sys-interaction-level {PASSIVE,INTERACTIVE,DISRUPTIVE}]
+usage: node-scraper [-h] [--sys-name STRING] [--sys-location {LOCAL,REMOTE}] [--sys-interaction-level {PASSIVE,INTERACTIVE,DISRUPTIVE}]
                      [--sys-sku STRING] [--sys-platform STRING] [--plugin-config STRING] [--system-config STRING] [--connection-config STRING]
                      [--log-path STRING] [--log-level {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}]
                      {run-plugins,gen-plugin-config,describe} ...
@@ -43,7 +43,7 @@ options:
                         Path to system config json (default: None)
   --connection-config STRING
                         Path to connection config json (default: None)
-  --log-path STRING     Specifies local path for error scraper logs, use 'None' to disable logging (default: .)
+  --log-path STRING     Specifies local path for node scraper logs, use 'None' to disable logging (default: .)
   --log-level {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}
                         Change python log level (default: INFO)
 
@@ -59,22 +59,22 @@ You can use the `describe` subcommand to display details about built-in configs
 
 #### List all built-in configs:
 ```sh
-error-scraper describe config
+node-scraper describe config
 ```
 
 #### Show details for a specific built-in config:
 ```sh
-error-scraper describe config <config-name>
+node-scraper describe config <config-name>
 ```
 
 #### List all available plugins:
 ```sh
-error-scraper describe plugin
+node-scraper describe plugin
 ```
 
 #### Show details for a specific plugin:
 ```sh
-error-scraper describe plugin <plugin-name>
+node-scraper describe plugin <plugin-name>
 ```
 
 ---
@@ -107,7 +107,7 @@ The 'gen-plugin-config' sub command can be used to generate a plugin config JSON
 
 Generate a config for the DmesgPlugin:
 ```sh
-error-scraper gen-plugin-config DmesgPlugin
+node-scraper gen-plugin-config DmesgPlugin
 ```
 
 This would produce the following config:
@@ -136,9 +136,9 @@ This would produce the following config:
 ### 'run-plugins' sub command
 The plugins to run and their associated arguments can also be specified directly on the CLI using the 'run-plugins' sub-command. Using this sub-command you can specify a plugin name followed by the arguments for that particular plugin. Multiple plugins can be specified at once.
 
-You can view the available arguments for a particular plugin by running `error-scraper run-plugins <plugin-name> -h`:
+You can view the available arguments for a particular plugin by running `node-scraper run-plugins <plugin-name> -h`:
 ```sh
-usage: error-scraper run-plugins BiosPlugin [-h] [--collection {True,False}] [--analysis {True,False}] [--system-interaction-level STRING]
+usage: node-scraper run-plugins BiosPlugin [-h] [--collection {True,False}] [--analysis {True,False}] [--system-interaction-level STRING]
                                             [--data STRING] [--exp-bios-version [STRING ...]] [--regex-match {True,False}]
 
 options:
@@ -156,22 +156,22 @@ options:
 
 Run a single plugin
 ```sh
-error-scraper run-plugins BiosPlugin --exp-bios-version TestBios123
+node-scraper run-plugins BiosPlugin --exp-bios-version TestBios123
 ```
 
 Run multiple plugins
 ```sh
-error-scraper run-plugins BiosPlugin --exp-bios-version TestBios123 RocmPlugin --exp-rocm TestRocm123
+node-scraper run-plugins BiosPlugin --exp-bios-version TestBios123 RocmPlugin --exp-rocm TestRocm123
 ```
 
 Run plugins without specifying args (plugin defaults will be used)
 
 ```sh
-error-scraper run-plugins BiosPlugin RocmPlugin
+node-scraper run-plugins BiosPlugin RocmPlugin
 ```
 
 Use plugin configs and 'run-plugins'
 
 ```sh
-error-scraper run-plugins BiosPlugin
+node-scraper run-plugins BiosPlugin
 ```

errorscraper/__init__.py nodescraper/__init__.pyerrorscraper/__init__.py renamed to nodescraper/__init__.py

@@ -26,13 +26,13 @@
 import logging
 from typing import Generic, Optional
 
-from errorscraper.connection.inband import InBandConnection
-from errorscraper.connection.inband.inband import CommandArtifact, FileArtifact
-from errorscraper.enums import EventPriority, OSFamily, SystemInteractionLevel
-from errorscraper.generictypes import TCollectArg, TDataModel
-from errorscraper.interfaces import DataCollector, TaskResultHook
-from errorscraper.interfaces.task import SystemCompatibilityError
-from errorscraper.models import SystemInfo
+from nodescraper.connection.inband import InBandConnection
+from nodescraper.connection.inband.inband import CommandArtifact, FileArtifact
+from nodescraper.enums import EventPriority, OSFamily, SystemInteractionLevel
+from nodescraper.generictypes import TCollectArg, TDataModel
+from nodescraper.interfaces import DataCollector, TaskResultHook
+from nodescraper.interfaces.task import SystemCompatibilityError
+from nodescraper.models import SystemInfo
 
 
 class InBandDataCollector(

errorscraper/base/__init__.py nodescraper/base/__init__.pyerrorscraper/base/__init__.py renamed to nodescraper/base/__init__.py

@@ -25,9 +25,9 @@
 ###############################################################################
 from typing import Generic
 
-from errorscraper.connection.inband import InBandConnectionManager, SSHConnectionParams
-from errorscraper.generictypes import TAnalyzeArg, TCollectArg, TDataModel
-from errorscraper.interfaces import DataPlugin
+from nodescraper.connection.inband import InBandConnectionManager, SSHConnectionParams
+from nodescraper.generictypes import TAnalyzeArg, TCollectArg, TDataModel
+from nodescraper.interfaces import DataPlugin
 
 
 class InBandDataPlugin(

errorscraper/base/inbandcollectortask.py nodescraper/base/inbandcollectortask.pyerrorscraper/base/inbandcollectortask.py renamed to nodescraper/base/inbandcollectortask.py

@@ -27,10 +27,10 @@
 
 from pydantic import BaseModel
 
-from errorscraper.enums import EventCategory, EventPriority
-from errorscraper.generictypes import TAnalyzeArg, TDataModel
-from errorscraper.interfaces.dataanalyzertask import DataAnalyzer
-from errorscraper.models.event import Event
+from nodescraper.enums import EventCategory, EventPriority
+from nodescraper.generictypes import TAnalyzeArg, TDataModel
+from nodescraper.interfaces.dataanalyzertask import DataAnalyzer
+from nodescraper.models.event import Event
 
 
 class ErrorRegex(BaseModel):

errorscraper/base/inbanddataplugin.py nodescraper/base/inbanddataplugin.pyerrorscraper/base/inbanddataplugin.py renamed to nodescraper/base/inbanddataplugin.py

@@ -31,17 +31,17 @@
 import sys
 from typing import Optional
 
-from errorscraper.cli.constants import DEFAULT_CONFIG, META_VAR_MAP
-from errorscraper.cli.dynamicparserbuilder import DynamicParserBuilder
-from errorscraper.cli.inputargtypes import ModelArgHandler, json_arg, log_path_arg
-from errorscraper.configbuilder import ConfigBuilder
-from errorscraper.configregistry import ConfigRegistry
-from errorscraper.constants import DEFAULT_LOGGER
-from errorscraper.enums import ExecutionStatus, SystemInteractionLevel, SystemLocation
-from errorscraper.models import PluginConfig, SystemInfo
-from errorscraper.pluginexecutor import PluginExecutor
-from errorscraper.pluginregistry import PluginRegistry
-from errorscraper.resultcollators.tablesummary import TableSummary
+from nodescraper.cli.constants import DEFAULT_CONFIG, META_VAR_MAP
+from nodescraper.cli.dynamicparserbuilder import DynamicParserBuilder
+from nodescraper.cli.inputargtypes import ModelArgHandler, json_arg, log_path_arg
+from nodescraper.configbuilder import ConfigBuilder
+from nodescraper.configregistry import ConfigRegistry
+from nodescraper.constants import DEFAULT_LOGGER
+from nodescraper.enums import ExecutionStatus, SystemInteractionLevel, SystemLocation
+from nodescraper.models import PluginConfig, SystemInfo
+from nodescraper.pluginexecutor import PluginExecutor
+from nodescraper.pluginregistry import PluginRegistry
+from nodescraper.resultcollators.tablesummary import TableSummary
 
 
 def build_parser(
@@ -58,7 +58,7 @@ def build_parser(
         parser and subparsers for each plugin module
     """
     parser = argparse.ArgumentParser(
-        description="Error scraper CLI",
+        description="node scraper CLI",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
@@ -126,7 +126,7 @@ def build_parser(
         "--log-path",
         default=".",
         type=log_path_arg,
-        help="Specifies local path for error scraper logs, use 'None' to disable logging",
+        help="Specifies local path for node scraper logs, use 'None' to disable logging",
         metavar=META_VAR_MAP[str],
     )