view test/test_demo.py @ 8412:0663a7bcef6c reauth-confirm_id

feat: finish reauth docs, enhance code. Decided to keep name Reauth for now. admin_guide.txt: add reference mark to roundup admin help. Used for template command reference in upgrading.txt. customizing.txt: added worked example of adding a reauth auditor for address and password. Also links to OWASP recommendations. Added link to example code in design.doc on detectors. glossary.txt: reference using roundup-admin template command in def for tracker templates. pydoc.txt: Added methods for Client class. Added class and methods for (cgi) Action, LoginAction and ReauthAction. reference.txt Edited and restructured detector section. Added section on registering a detector and priority use/execution order. (reference to design doc was used before). Added/enhanced description of exception an auditor can raise (includes Reauth). Added section on Reauth implementation and use (Confirming the User). Also has paragraph on future ideas. upgrading.txt Stripped down the original section. Moved a lot to reference.txt. Referenced customizing example, mention installation of _generic.reauth.html and reference reference.txt. cgi/actions.py: fixed bad ReST that was breaking pydoc.txt processing changed doc on limitations of Reauth code. added docstring for Reauth::verifyPassword cgi/client.py: fix ReST for a method breaking pydoc.py processing cgi/templating.py: fix docstring on embed_form_fields templates/*/html/_generic.reauth.html disable spelling for password field add timing info to the javascript function that processes file data. reformat javascript IIFE templates/jinja2/html/_generic.reauth.html create a valid jinja2 template. Looks like my original jinja template got overwritten and committed. feature parity with the other reauth templates. test/test_liveserver.py add test case for Reauth workflow. Makefile add doc.
author John Rouillard <rouilj@ieee.org>
date Wed, 13 Aug 2025 23:52:49 -0400
parents 618dccf7199d
children
line wrap: on
line source

import pytest
import unittest
import os, sys, shutil

from os.path import normpath

from roundup.demo import install_demo, run_demo

import roundup.scripts.roundup_server

# https://stackoverflow.com/questions/4219717/how-to-assert-output-with-nosetest-unittest-in-python
# lightly modified
from contextlib import contextmanager
_py3 = sys.version_info[0] > 2
if _py3:
    from io import StringIO # py3
else:
    from StringIO import StringIO # py2
@contextmanager
def captured_output():
    new_out, new_err = StringIO(), StringIO()
    old_out, old_err = sys.stdout, sys.stderr
    try:
        sys.stdout, sys.stderr = new_out, new_err
        yield sys.stdout, sys.stderr
    finally:
        sys.stdout, sys.stderr = old_out, old_err

try:
    import jinja2
    skip_jinja2 = lambda func, *args, **kwargs: func
except ImportError:
    from .pytest_patcher import mark_class
    skip_jinja2 = mark_class(pytest.mark.skip(
        reason='Skipping Jinja2 tests: jinja2 library not available'))

class TestDemo(unittest.TestCase):
    def setUp(self):
        self.home = os.path.abspath('_test_demo')

    def tearDown(self):
        try:
            shutil.rmtree(self.home)
        except FileNotFoundError:
            pass
        
    def run_install_demo(self, template, db="anydbm"):
        with captured_output() as (out, err):
            install_demo(self.home, db, template)
        output = out.getvalue().strip()
        print(output)

        # verify that db was set properly by reading config
        with open(self.home + "/config.ini", "r") as f:
            config_lines = f.read().replace("\r\n", "\n")

        try:
            # handle text files with \r\n line endings
            config_lines.index("\r", 0, 100)
            config_lines = config_lines.replace("\r\n", "\n")
        except ValueError:
            pass

        self.assertIn("backend = %s\n"%db, config_lines)

        # dummy up the return of get_server so the serve_forever method
        # raises keyboard interrupt exiting the server so the test exits.
        gs = roundup.scripts.roundup_server.ServerConfig.get_server
        def raise_KeyboardInterrupt():
            raise KeyboardInterrupt

        def test_get_server(self):
            httpd = gs(self)
            httpd.serve_forever = raise_KeyboardInterrupt
            return httpd

        roundup.scripts.roundup_server.ServerConfig.get_server = test_get_server

        # Run under context manager to capture output of startup text.
        with captured_output() as (out, err):
            run_demo(self.home)
        output = out.getvalue().strip()
        print(output)
        # if the server installed and started this will be the
        # last line in the output.
        self.assertIn("Keyboard Interrupt: exiting", output.split('\n'))

    def testDemoClassic(self):
        with captured_output() as (out, err):
            self.run_install_demo("classic")
        self.assertIn("http://localhost:8917/demo/", out.getvalue())

        # verify the default anydbm db is created
        db_file = self.home + normpath("/db/nodes.user")
        db_file2 = db_file + '.db'
        db_file_dumbdbm = self.home + normpath("/db/nodes.user.dir")
        self.assertTrue(os.path.isfile(db_file) or
                        os.path.isfile(db_file2) or
                        os.path.isfile(db_file_dumbdbm),
                        "expected db file %s[.db] or %s does not exist" % (
                            db_file, db_file_dumbdbm
                        ))

         # verify requested template was used
        with open(self.home + "/TEMPLATE-INFO.txt", "r") as f:
            info_lines = f.read()

        try:
            # handle text files with \r\n line endings
            info_lines.index("\r", 0, 100)
            info_lines = info_lines.replace("\r\n", "\n")
        except ValueError:
            pass

        self.assertIn("Name: classic-_test_demo\n", info_lines)

    def testDemoMinimal(self):
        # test explicit path to template as others test template
        # search path.
        with captured_output() as (out, err):
            self.run_install_demo('../templates/minimal', db="sqlite")
        self.assertIn("http://localhost:8917/demo/", out.getvalue())

        # verify the requested sqlite db file is created
        db_file = self.home + "/db/db"
        self.assertTrue(os.path.isfile(db_file),
                        "expected db file %s does not exist" % db_file)

        # verify requested template was used
        with open(self.home + "/TEMPLATE-INFO.txt", "r") as f:
            info_lines = f.read()

        try:
            # handle text files with \r\n line endings
            info_lines.index("\r", 0, 100)
            info_lines = info_lines.replace("\r\n", "\n")
        except ValueError:
            pass

        self.assertIn("Name: minimal-_test_demo\n", info_lines)

    @skip_jinja2
    def testDemoJinja(self):
        with captured_output() as (out, err):
            self.run_install_demo('jinja2', db="anydbm")
        self.assertIn("http://localhost:8917/demo/", out.getvalue())

        # verify the requested anydbm db file is created
        db_file = self.home + "/db/nodes.user"
        db_file2 = db_file + '.db'
        self.assertTrue(os.path.isfile(db_file) or os.path.isfile(db_file2),
                        "expected db file %s[.db] does not exist" % db_file)

        # verify that template was set to jinja2 by reading config
        with open(self.home + "/config.ini", "r") as f:
            config_lines = f.read()

        try:
            # handle text files with \r\n line endings
            config_lines.index("\r", 0, 100)
            config_lines = config_lines.replace("\r\n", "\n")
        except ValueError:
            pass

        self.assertIn("template_engine = jinja2\n", config_lines)


Roundup Issue Tracker: http://roundup-tracker.org/