Thu Jun 6 18:13:35 EDT 2024 Updated to meet PEP

.bumpversion.cfg

@@ -11,4 +11,6 @@ tag = True
 
 [bumpversion:file:geese/version.py]
 
-[bumpversion:file:tests.py]
+[bumpversion:file:tests/tests.py]
+
+[bumpversion:file:pyproject.toml]

.github/workflows/python-package.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "next" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest build
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 ./geese --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 ./geese --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

.gitignore

@@ -10,6 +10,7 @@ dist/*
 logs/
 node_modules/
 yarn.lock
+build/
 config.yaml
 cribl/
 sample.sh

geese/KennyLoggins.py

@@ -26,4 +26,3 @@ def get_logger(file_name, root_folder=os.getcwd(), log_level=logger.INFO):
         if not len(_log.handlers):
             _log.addHandler(f_handle)
         return _log
-

geese/commands/commit.py

@@ -1,9 +1,5 @@
-import json
-import os
 import re
-
-import yaml
-from yaml import YAMLError, safe_dump
+from yaml import YAMLError
 import geese.constants.exit_codes as ec
 import argparse
 import sys

geese/commands/export.py

@@ -1,15 +1,12 @@
 import json
 import os
-
 from yaml import YAMLError, safe_dump
 import geese.constants.exit_codes as ec
 import argparse
 import sys
-
-from geese.utils.operations import validate, load_tuning, validate_knowledge
+from geese.utils.operations import load_tuning, validate_knowledge
 from geese.constants.common_arguments import add_arguments
-from geese.constants.configs import colors, export_cmd, tuning, import_cmd
-
+from geese.constants.configs import colors, export_cmd, tuning
 # Check for a "get diff" api call
 
 

geese/commands/import.py

@@ -1,7 +1,7 @@
 import json
 import os
 import yaml
-from yaml import YAMLError, safe_dump
+from yaml import YAMLError
 import geese.constants.exit_codes as ec
 import argparse
 import sys

geese/commands/migrate.py

@@ -1,15 +1,11 @@
-import json
-import os
 import re
-
-import yaml
-from yaml import YAMLError, safe_dump
+from yaml import YAMLError
 import geese.constants.exit_codes as ec
 import argparse
 import sys
 from geese.constants.common_arguments import add_arguments
 from geese.constants.configs import colors
-from geese.knowledge import Versioning, Worker
+from geese.knowledge import Worker
 
 
 def _migrate_workers(self, args):

geese/commands/simulate.py

@@ -1,6 +1,5 @@
 import json
 import os
-
 import yaml
 from yaml import YAMLError, safe_dump
 import geese.constants.exit_codes as ec

geese/constants/configs.py

@@ -26,4 +26,4 @@
 }
 tuning = {
     "file": None
-}
+}

geese/goose.py

@@ -351,7 +351,7 @@ def perform_import(self, items):
                                                                                      group=group,
                                                                                      item=individual_item)
                     elif func not in destination_groups_only:
-                        self._display(f"\t\tNo Groups", colors["info"])
+                        self._display("\t\tNo Groups", colors["info"])
                         import_result = self._perform_operation(self.objects[func], "import", self.destination,
                                                                 item=individual_item)
                     if "worker_groups" in self.destination:

geese/knowledge/appscope_configs.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/auth_config.py

@@ -12,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"system/settings/auth"
+            self.endpoint = "system/settings/auth"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/authentication.py

@@ -1,5 +1,3 @@
-import json
-from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
 

geese/knowledge/base.py

@@ -1,9 +1,7 @@
 import os
 import sys
-
 import requests
 import json
-from copy import deepcopy
 from deepdiff import DeepDiff
 from termcolor import colored
 
@@ -244,7 +242,7 @@ def _update_item(self, action, item, id_field="id", changes=None, update_on_crea
                         for m in msg:
                             t.append(f'{m["keyword"]}:\n\t\t{m["message"]}\n\t\t{m["params"]}\n\t\t{m["schemaPath"]}')
                         msg = "\n\t".join(t)
-                    except Exception as e:
+                    except:
                         msg = result.text
                     self._display(f"\t{item[id_field]}: Create failed. \n\t{msg}", self.colors.get("error", "red"))
                     changes["updated"] = {"status": "create_failed", "data": item, "error": result.text}

geese/knowledge/collectors.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/database_connections.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/event_breaker_rules.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/fleet_mappings.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -13,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"fleet-mappings"
+            self.endpoint = "fleet-mappings"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/global_variables.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/grokfiles.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/groups.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -9,7 +8,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, produ
         super().__init__(leader, args, logger, **kwargs)
         self.obj_type = "groups"
         self.default_types = []
-        self.endpoint = f"products/{product}/groups" if f'{leader["is_cloud"]}' == "true" else f"master/groups"
+        self.endpoint = f"products/{product}/groups" if f'{leader["is_cloud"]}' == "true" else "master/groups"
         self.group = None
         self.supports_groups = False
 
@@ -82,7 +81,7 @@ def workers(self, group=None):
         payload = {
             "filterExp": f'group=="{group}" && info.cribl.distMode=="worker"',
         }
-        data = self.get(endpoint=f"master/workers", payload=payload)
+        data = self.get(endpoint="master/workers", payload=payload)
         if data.status_code == 200 and data.json():
             items = [p for p in data.json()["items"] if p["id"] not in self.default_types or self.args.keep_defaults
                      and p["group"] == group]

geese/knowledge/inputs.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/keys.py

@@ -12,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"system/keys"
+            self.endpoint = "system/keys"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/lookups.py

@@ -16,7 +16,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
             self.group = None
             if group is not None or fleet is not None:
                 self.group = fleet if fleet is not None else group
-                self.endpoint = f"system/lookups"
+                self.endpoint = "system/lookups"
         except Exception as e:
             self._display_error("Unhandled INIT Exception", e)
 

geese/knowledge/mappings.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -13,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"mappings"
+            self.endpoint = "mappings"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/notification_targets.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -13,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"notification-targets"
+            self.endpoint = "notification-targets"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/notifications.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -13,7 +12,7 @@ def __init__(self, leader, args=None, logger=None, group=None, fleet=None, **kwa
         self.group = None
         if group is not None or fleet is not None:
             self.group = fleet if fleet is not None else group
-            self.endpoint = f"notifications"
+            self.endpoint = "notifications"
 
     def export(self):
         action = f"export_{self.obj_type}"

geese/knowledge/outputs.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/packs.py

@@ -54,7 +54,7 @@ def save_pack(self, directory, pack):
                 self._display(
                     f"\tPack {pack_id}: API responded with error: {json.loads(response.text)['message']}",
                     self.colors.get("error", "yellow"))
-                self._display(f"\tAttempting to export pack using mode=merge...",
+                self._display("\tAttempting to export pack using mode=merge...",
                               self.colors.get("warning", "yellow"))
                 # try merge
                 response = self._export_pack_merge(pack_id)
@@ -84,8 +84,8 @@ def save_pack(self, directory, pack):
         return pack
 
     def export(self, save_pack=True):
+        action = f"export_{self.obj_type}"
         try:
-            action = f"export_{self.obj_type}"
             data = self.get(self.endpoint)
             packs = []
             if data.status_code == 200 and data.json():
@@ -107,7 +107,7 @@ def export(self, save_pack=True):
                             self.save_pack(directory, pack)
             return packs
         except Exception as e:
-            self._display_error(f"Unhandled EXPORT Exception: {self.obj_type}", e)
+            self._display_error(f"{action} Unhandled EXPORT Exception: {self.obj_type}", e)
             return []
 
     def _upload_and_install(self, pack):

geese/knowledge/parquet_schemas.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/parsers.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 

geese/knowledge/pipelines.py

@@ -1,6 +1,5 @@
 import copy
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge
 
@@ -84,7 +83,7 @@ def update(self, item=None):
                         for m in msg:
                             t.append(f'{m["keyword"]}:\n\t\t{m["message"]}\n\t\t{m["params"]}\n\t\t{m["schemaPath"]}')
                         msg = "\n\t".join(t)
-                    except Exception as e:
+                    except:
                         msg = result.text
                     self._display(f"\t{item['id']}: Create failed. \n\t{msg}", self.colors.get("error", "red"))
                     changes["updated"] = {"status": "create_failed", "data": item, "error": result.text}

geese/knowledge/regexes.py

@@ -1,5 +1,4 @@
 import json
-import os
 from deepdiff import DeepDiff
 from geese.knowledge.base import BaseKnowledge