lanscape 1.3.2a11__tar.gz → 1.3.3__tar.gz

{lanscape-1.3.2a11/lanscape.egg-info → lanscape-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lanscape
-Version: 1.3.2a11
+Version: 1.3.3
 Summary: A python based local network scanner
 Author-email: Michael Dennis <michael@dipduo.com>
 License-Expression: MIT
@@ -37,7 +37,7 @@ python -m lanscape
  - `--port <port number>` port of the flask app (default: automagic)
  - `--persistent` dont shutdown server when browser tab is closed (default: false)
  - `--reloader` essentially flask debug mode- good for local development (default: false)
- - `--logfile` save log output to lanscape.log
+ - `--logfile <path>` save log output to the given file path
  - `--loglevel <level>` set the logger's log level (default: INFO)
  - `--flask-logging` turn on flask logging (default: false)
 
@@ -45,7 +45,7 @@ Examples:
 ```shell
 python -m lanscape --reloader
 python -m lanscape --port 5002
-python -m lanscape --logfile --loglevel DEBUG
+python -m lanscape --logfile /tmp/lanscape.log --loglevel DEBUG
 ```
 
 ## Troubleshooting

{lanscape-1.3.2a11 → lanscape-1.3.3}/README.md

@@ -13,7 +13,7 @@ python -m lanscape
  - `--port <port number>` port of the flask app (default: automagic)
  - `--persistent` dont shutdown server when browser tab is closed (default: false)
  - `--reloader` essentially flask debug mode- good for local development (default: false)
- - `--logfile` save log output to lanscape.log
+ - `--logfile <path>` save log output to the given file path
  - `--loglevel <level>` set the logger's log level (default: INFO)
  - `--flask-logging` turn on flask logging (default: false)
 
@@ -21,7 +21,7 @@ Examples:
 ```shell
 python -m lanscape --reloader
 python -m lanscape --port 5002
-python -m lanscape --logfile --loglevel DEBUG
+python -m lanscape --logfile /tmp/lanscape.log --loglevel DEBUG
 ```
 
 ## Troubleshooting

{lanscape-1.3.2a11 → lanscape-1.3.3}/lanscape/libraries/logger.py

@@ -1,9 +1,10 @@
 import logging
 from logging.handlers import RotatingFileHandler
 import click
+from typing import Optional
 
 
-def configure_logging(loglevel: str, logfile: bool, flask_logging: bool = False) -> None:
+def configure_logging(loglevel: str, logfile: Optional[str], flask_logging: bool = False) -> None:
     numeric_level = getattr(logging, loglevel.upper(), None)
     if not isinstance(numeric_level, int):
         raise ValueError(f'Invalid log level: {loglevel}')
@@ -17,7 +18,7 @@ def configure_logging(loglevel: str, logfile: bool, flask_logging: bool = False)
 
     if logfile:
         handler = RotatingFileHandler(
-            'lanscape.log', maxBytes=100000, backupCount=3)
+            logfile, maxBytes=100000, backupCount=3)
         handler.setLevel(numeric_level)
         formatter = logging.Formatter(
             '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

{lanscape-1.3.2a11 → lanscape-1.3.3}/lanscape/libraries/runtime_args.py

@@ -1,14 +1,13 @@
-import argparse
 from dataclasses import dataclass, fields
 import argparse
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 
 @dataclass
 class RuntimeArgs:
     reloader: bool = False
     port: int = 5001
-    logfile: bool = False
+    logfile: Optional[str] = None
     loglevel: str = 'INFO'
     flask_logging: bool = False
     persistent: bool = False
@@ -21,8 +20,8 @@ def parse_args() -> RuntimeArgs:
                         help='Use flask\'s reloader (helpful for local development)')
     parser.add_argument('--port', type=int, default=5001,
                         help='Port to run the webserver on')
-    parser.add_argument('--logfile', action='store_true',
-                        help='Log output to lanscape.log')
+    parser.add_argument('--logfile', type=str, default=None,
+                        help='Log output to the specified file path')
     parser.add_argument('--loglevel', default='INFO', help='Set the log level')
     parser.add_argument('--flask-logging', action='store_true',
                         help='Enable flask logging (disables click output)')

{lanscape-1.3.2a11 → lanscape-1.3.3/lanscape.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lanscape
-Version: 1.3.2a11
+Version: 1.3.3
 Summary: A python based local network scanner
 Author-email: Michael Dennis <michael@dipduo.com>
 License-Expression: MIT
@@ -37,7 +37,7 @@ python -m lanscape
  - `--port <port number>` port of the flask app (default: automagic)
  - `--persistent` dont shutdown server when browser tab is closed (default: false)
  - `--reloader` essentially flask debug mode- good for local development (default: false)
- - `--logfile` save log output to lanscape.log
+ - `--logfile <path>` save log output to the given file path
  - `--loglevel <level>` set the logger's log level (default: INFO)
  - `--flask-logging` turn on flask logging (default: false)
 
@@ -45,7 +45,7 @@ Examples:
 ```shell
 python -m lanscape --reloader
 python -m lanscape --port 5002
-python -m lanscape --logfile --loglevel DEBUG
+python -m lanscape --logfile /tmp/lanscape.log --loglevel DEBUG
 ```
 
 ## Troubleshooting

{lanscape-1.3.2a11 → lanscape-1.3.3}/lanscape.egg-info/SOURCES.txt

@@ -74,4 +74,5 @@ lanscape/ui/templates/scan/scan-error.html
 tests/test_api.py
 tests/test_env.py
 tests/test_library.py
+tests/test_logging.py
 tests/test_utils.py

{lanscape-1.3.2a11 → lanscape-1.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lanscape"
-version = "1.3.2a11"
+version = "1.3.3"
 authors = [
   { name="Michael Dennis", email="michael@dipduo.com" },
 ]

lanscape-1.3.3/tests/test_logging.py

@@ -0,0 +1,55 @@
+import unittest
+import logging
+import os
+import tempfile
+from unittest.mock import patch
+
+import click
+from logging.handlers import RotatingFileHandler
+
+from lanscape.libraries.logger import configure_logging
+from lanscape.libraries.runtime_args import parse_args
+
+
+class LoggingConfigTests(unittest.TestCase):
+    def setUp(self):
+        self.root = logging.getLogger()
+        self.root.handlers.clear()
+        self.original_click_echo = click.echo
+        self.original_click_secho = click.secho
+
+    def tearDown(self):
+        self.root.handlers.clear()
+        logging.shutdown()
+        click.echo = self.original_click_echo
+        click.secho = self.original_click_secho
+
+    def test_configure_logging_writes_file(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            logfile = os.path.join(tmpdir, 'test.log')
+            configure_logging('INFO', logfile, flask_logging=True)
+            logging.getLogger('test').info('hello file')
+            for handler in logging.getLogger().handlers:
+                handler.flush()
+            with open(logfile, 'r') as fh:
+                contents = fh.read()
+            self.assertIn('hello file', contents)
+            self.tearDown()
+
+    def test_configure_logging_without_file(self):
+        configure_logging('INFO', None, flask_logging=True)
+        root_handlers = logging.getLogger().handlers
+        self.assertTrue(all(not isinstance(h, RotatingFileHandler) for h in root_handlers))
+
+    def test_disable_flask_logging_overrides_click(self):
+        configure_logging('INFO', None, flask_logging=False)
+        self.assertNotEqual(click.echo, self.original_click_echo)
+        self.assertNotEqual(click.secho, self.original_click_secho)
+        self.assertEqual(logging.getLogger('werkzeug').level, logging.ERROR)
+
+
+class RuntimeArgsLoggingTests(unittest.TestCase):
+    def test_parse_args_logfile_path(self):
+        with patch('sys.argv', ['prog', '--logfile', '/tmp/custom.log']):
+            args = parse_args()
+        self.assertEqual(args.logfile, '/tmp/custom.log')

{lanscape-1.3.2a11 → lanscape-1.3.3}/tests/test_utils.py

@@ -3,7 +3,6 @@ from lanscape.libraries.ip_parser import parse_ip_input
 from lanscape.libraries.errors import SubnetTooLargeError
 import ipaddress
 from lanscape.libraries import ip_parser
-from lanscape.libraries.errors import SubnetTooLargeError
 from lanscape.libraries.port_manager import PortManager
 from lanscape.libraries.decorators import timeout_enforcer
 import time
@@ -54,7 +53,7 @@ class PortManagerValidateTests(unittest.TestCase):
 
     def test_validate_port_data_valid(self):
         valid = {"80": "http", "443": "https"}
-        self.assertTrue(PortManager.validate_port_data(self.pm, valid))
+        self.assertTrue(self.pm.validate_port_data(valid))
 
     def test_validate_port_data_invalid(self):
         invalid_cases = [
@@ -65,14 +64,14 @@ class PortManagerValidateTests(unittest.TestCase):
         ]
         for case in invalid_cases:
             with self.subTest(case=case):
-                self.assertFalse(PortManager.validate_port_data(self.pm, case))
+                self.assertFalse(self.pm.validate_port_data(case))
 
 
 class DecoratorTimeoutTests(unittest.TestCase):
     def test_timeout_enforcer(self):
         @timeout_enforcer(0.1, raise_on_timeout=False)
         def slow_return():
-            time.sleep(0.2)
+            time.sleep(0.5)
             return "done"
 
         self.assertIsNone(slow_return())