changedetection.io/changedetectionio/tests/util.py

#!/usr/bin/python3

from flask import make_response, request

def set_original_response():
    test_return_data = """<html>
    <head><title>head title</title></head>
    <body>
     Some initial text</br>
     <p>Which is across multiple lines</p>
     </br>
     So let's see what happens.  </br>
     </body>
     </html>
    """

    with open("test-datastore/endpoint-content.txt", "w") as f:
        f.write(test_return_data)
    return None

def set_modified_response():
    test_return_data = """<html>
    <head><title>modified head title</title></head>
    <body>
     Some initial text</br>
     <p>which has this one new line</p>
     </br>
     So let's see what happens.  </br>
     </body>
     </html>
    """

    with open("test-datastore/endpoint-content.txt", "w") as f:
        f.write(test_return_data)

    return None


def live_server_setup(live_server):


    @live_server.app.route('/test-endpoint')
    def test_endpoint():
        ctype = request.args.get('content_type')

        # Tried using a global var here but didn't seem to work, so reading from a file instead.
        with open("test-datastore/endpoint-content.txt", "r") as f:
            resp = make_response(f.read())
            resp.headers['Content-Type'] = ctype if ctype else 'text/html'
            return resp

    @live_server.app.route('/test-403')
    def test_endpoint_403_error():
        resp = make_response('', 403)
        return resp

    # Just return the headers in the request
    @live_server.app.route('/test-headers')
    def test_headers():

        output= []

        for header in request.headers:
             output.append("{}:{}".format(str(header[0]),str(header[1])   ))

        return "\n".join(output)

    # Just return the body in the request
    @live_server.app.route('/test-body', methods=['POST', 'GET'])
    def test_body():
        return request.data

    # Just return the verb in the request
    @live_server.app.route('/test-method', methods=['POST', 'GET', 'PATCH'])
    def test_method():
        return request.method

    # Where we POST to as a notification
    @live_server.app.route('/test_notification_endpoint', methods=['POST', 'GET'])
    def test_notification_endpoint():
        with open("test-datastore/notification.txt", "wb") as f:
            # Debug method, dump all POST to file also, used to prove #65
            data = request.stream.read()
            if data != None:
                f.write(data)

        print("\n>> Test notification endpoint was hit.\n")
        return "Text was set"


    # Just return the verb in the request
    @live_server.app.route('/test-basicauth', methods=['GET'])
    def test_basicauth_method():
        auth = request.authorization
        ret = " ".join([auth.username, auth.password, auth.type])
        return ret

    live_server.start()
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`#!/usr/bin/python3`

Better text/plain detection and refactor tests (#443) 3 years ago			`from flask import make_response, request`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago
			`def set_original_response():`
			`test_return_data = """<html>`
Auto extract html title as title (#102) * Auto extract <title> as watch title, Minor refactor for html tooling 3 years ago			`<head><title>head title</title></head>`
			`<body>`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`Some initial text</br>`
			`<p>Which is across multiple lines</p>`
			`</br>`
			`So let's see what happens. </br>`
			`</body>`
			`</html>`
			`"""`

Chrome/Webdriver support for Javascript websites (#114) JS Support via fetching the page over WebDriver/Selenium network Refactor forms (Split into logical tabs) 3 years ago			`with open("test-datastore/endpoint-content.txt", "w") as f:`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`f.write(test_return_data)`
			`return None`

			`def set_modified_response():`
			`test_return_data = """<html>`
Auto extract html title as title (#102) * Auto extract <title> as watch title, Minor refactor for html tooling 3 years ago			`<head><title>modified head title</title></head>`
			`<body>`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`Some initial text</br>`
			`<p>which has this one new line</p>`
			`</br>`
			`So let's see what happens. </br>`
			`</body>`
			`</html>`
			`"""`

Chrome/Webdriver support for Javascript websites (#114) JS Support via fetching the page over WebDriver/Selenium network Refactor forms (Split into logical tabs) 3 years ago			`with open("test-datastore/endpoint-content.txt", "w") as f:`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`f.write(test_return_data)`

			`return None`


			`def live_server_setup(live_server):`

Re #137 - Adding test to confirm that headers are not repeated 3 years ago
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`@live_server.app.route('/test-endpoint')`
			`def test_endpoint():`
Better text/plain detection and refactor tests (#443) 3 years ago			`ctype = request.args.get('content_type')`
Be sure that documents returned with a application/json header are not parsed with inscriptis (#337) * Auto-detect JSON by Content-Type header * Add test to not parse JSON responses with inscriptis 3 years ago
Better text/plain detection and refactor tests (#443) 3 years ago			`# Tried using a global var here but didn't seem to work, so reading from a file instead.`
Be sure that documents returned with a application/json header are not parsed with inscriptis (#337) * Auto-detect JSON by Content-Type header * Add test to not parse JSON responses with inscriptis 3 years ago			`with open("test-datastore/endpoint-content.txt", "r") as f:`
			`resp = make_response(f.read())`
Better text/plain detection and refactor tests (#443) 3 years ago			`resp.headers['Content-Type'] = ctype if ctype else 'text/html'`
Be sure that documents returned with a application/json header are not parsed with inscriptis (#337) * Auto-detect JSON by Content-Type header * Add test to not parse JSON responses with inscriptis 3 years ago			`return resp`

Better handling of EmptyReply exception, always bump 'last_checked' in the case of an error (#354) * Better handling of EmptyReply exception, always bump 'last_checked' in the case of an error, adds test 3 years ago			`@live_server.app.route('/test-403')`
			`def test_endpoint_403_error():`
			`resp = make_response('', 403)`
			`return resp`

Re #137 - Adding test to confirm that headers are not repeated 3 years ago			`# Just return the headers in the request`
			`@live_server.app.route('/test-headers')`
			`def test_headers():`

			`output= []`

			`for header in request.headers:`
			`output.append("{}:{}".format(str(header[0]),str(header[1]) ))`

			`return "\n".join(output)`

Extend Request Parameters to add Body & Method (#325) 3 years ago			`# Just return the body in the request`
			`@live_server.app.route('/test-body', methods=['POST', 'GET'])`
			`def test_body():`
			`return request.data`

			`# Just return the verb in the request`
			`@live_server.app.route('/test-method', methods=['POST', 'GET', 'PATCH'])`
			`def test_method():`
			`return request.method`
Re #137 - Adding test to confirm that headers are not repeated 3 years ago
Customisable notifications (#123) * Customisable notifications (#121) * Test improvements * Setup BASE_URL environment in test Co-authored-by: dtomlinson91 <53234158+dtomlinson91@users.noreply.github.com> 3 years ago			`# Where we POST to as a notification`
Re #185 - [feature] Custom notifications templates per watch (#226) * Re #185 - [feature] Custom text templates for the notification per monitored entry as override. Bonus points: Adding validation for apprise URLs 3 years ago			`@live_server.app.route('/test_notification_endpoint', methods=['POST', 'GET'])`
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`def test_notification_endpoint():`
Customisable notifications (#123) * Customisable notifications (#121) * Test improvements * Setup BASE_URL environment in test Co-authored-by: dtomlinson91 <53234158+dtomlinson91@users.noreply.github.com> 3 years ago			`with open("test-datastore/notification.txt", "wb") as f:`
Re #65 - Append BASE_URL env var to the notification if it is set (#66) * Re #65 - Append BASE_URL env var to the notification if it is set 4 years ago			`# Debug method, dump all POST to file also, used to prove #65`
			`data = request.stream.read()`
			`if data != None:`
Customisable notifications (#123) * Customisable notifications (#121) * Test improvements * Setup BASE_URL environment in test Co-authored-by: dtomlinson91 <53234158+dtomlinson91@users.noreply.github.com> 3 years ago			`f.write(data)`
Re #65 - Append BASE_URL env var to the notification if it is set (#66) * Re #65 - Append BASE_URL env var to the notification if it is set 4 years ago
Apprise notifications (#43) * issue #4 Adding settings screen for apprise URLS * Adding test notification mechanism * Move Worker module to own class file * Adding basic notification URL runner * Tests for notifications * Tweak readme with notification info * Move notification test to main test_backend.py * Fix spacing * Adding notifications screenshot * Cleanup more files from test * Offer send notification test on individual edits and main/default * Process global notifications * All branches test * Wrap worker notification process in try/catch, use global if nothing set * Fix syntax * Handle exception, increase wait time for liveserver to come up * Fixing test setup * remove debug * Split tests into their own totally isolated setups, if you know a better way to make live_server() work, MR :) * Tidying up lint/imports 4 years ago			`print("\n>> Test notification endpoint was hit.\n")`
			`return "Text was set"`

Simple HTTP auth (#372) HTTP Basic Auth form validation 3 years ago
			`# Just return the verb in the request`
			`@live_server.app.route('/test-basicauth', methods=['GET'])`
			`def test_basicauth_method():`
			`auth = request.authorization`
			`ret = " ".join([auth.username, auth.password, auth.type])`
			`return ret`

Customisable notifications (#123) * Customisable notifications (#121) * Test improvements * Setup BASE_URL environment in test Co-authored-by: dtomlinson91 <53234158+dtomlinson91@users.noreply.github.com> 3 years ago			`live_server.start()`