Gitweb links: ...log http://git.netsurf-browser.org/netsurf.git/shortlog/fa1f1dcd1188ab80803b1... ...commit http://git.netsurf-browser.org/netsurf.git/commit/fa1f1dcd1188ab80803b1ef... ...tree http://git.netsurf-browser.org/netsurf.git/tree/fa1f1dcd1188ab80803b1ef07... The branch, master has been updated via fa1f1dcd1188ab80803b1ef0773020d1378dbfc4 (commit) via 9ec17b011b0b131ef330dc654ebf00135849361e (commit) via e070f13093a23ea7ac962fffd3d1821ced9894e3 (commit) via 710818f346a35facadc28cd1f25824d99ca72306 (commit) via 9cb7d0ab4844cbc79e6d2937306fdb0501af4fef (commit) via 19dded8cfa7a7772d5a6ece3e5b975c142e85456 (commit) from 4cbdcc4aae940065d027157c1bce2dbfc7d59c3b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=fa1f1dcd1188ab80803... commit fa1f1dcd1188ab80803b1ef0773020d1378dbfc4 Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; fix start stop test to set launch options correctly diff --git a/test/monkey-tests/start-stop-no-js.yaml b/test/monkey-tests/start-stop-no-js.yaml index 0a681cf..028e08f 100644 --- a/test/monkey-tests/start-stop-no-js.yaml +++ b/test/monkey-tests/start-stop-no-js.yaml @@ -1,8 +1,7 @@ title: start and stop browser without JS -group: basic +group: initial steps: - action: launch - args: + options: - enable_javascript=0 - action: quit - commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=9ec17b011b0b131ef33... commit 9ec17b011b0b131ef330dc654ebf00135849361e Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; Document the integration test setup diff --git a/docs/development.md b/docs/development.md index c9268d4..5a8d1aa 100644 --- a/docs/development.md +++ b/docs/development.md @@ -65,47 +65,9 @@ functions. # Integration testing -The monkey frontend is used to perform complex tests involving -operating the browser as a user might (opening windows, navigating to -websites and rendering the contents etc.) - -A test is written as a set of operations in a yaml file. A test can be -run using the monkey_driver.py python script - - $ ./test/monkey_driver.py -m ./nsmonkey -t test/monkey-tests/start-stop.yaml - -There are very few tests within the netsurf repository. The large -majority of integration tests are held within the -[netsurf-test](http://source.netsurf-browser.org/netsurf-test.git/) -repository. - -To allow more effective use of these tests additional infrastructure -has been constructed to allow groupings of tests to be run. This is -used extensively by the CI system to perform integration testing on -every commit. - -Each test is a member of a group and the tests within each group are -run together. Groups are listed within division index files. To run -the integration tests the monkey-see-monkey-do python script is -used. It downloads the test plan for a division from the netsurf test -infrastructrure and executes it. - - $ ./test/monkey-see-monkey-do - Fetching tests... - Parsing tests... - Running tests... - Start group: initial - [ Basic checks that the browser can start and stop ] - => Run test: start-stop-no-js.yaml - => Run test: basic-navigation.yaml - => Run test: start-stop.yaml - Start group: no-networking - [ Tests that require no networking ] - => Run test: resource-scheme.yaml - Start group: ecmascript - [ ECMAScript tests ] - PASS - +NetSurf [integration tests](docs/integration-testing.md) use the +monkey frontend to operate the browser as a whole. These tests open +windows, navigate to websites and render contents as a user might. # Documented API diff --git a/docs/integration-testing.md b/docs/integration-testing.md new file mode 100644 index 0000000..defcc17 --- /dev/null +++ b/docs/integration-testing.md @@ -0,0 +1,545 @@ +NetSurf Integration Testing +=========================== + +Overview +-------- + +The monkey frontend is used to perform complex tests involving +operating the browser as a user might (opening windows, navigating to +websites and rendering the contents etc.) + +A test is written as a set of operations in a yaml file. These files +are parsed and executed by the monkey driver script. + +There are very few tests within the NetSurf repository. The large +majority of integration tests are instead held within the +[netsurf-test](http://source.netsurf-browser.org/netsurf-test.git/) +repository. + +To allow more effective use of these tests additional infrastructure +has been constructed to allow groupings of tests to be run. This is +used extensively by the CI system to perform integration testing on +every commit. + +The infrastructure also provides for special CGI scripts which have +known behaviours such as delays or returning specific content to +extend test capabilities. + + +Running a test +-------------- + +An individual test can be run using the monkey_driver.py python script +from within the NetSurf repository + + $ make TARGET=monkey + $ ./test/monkey_driver.py -m ./nsmonkey -t test/monkey-tests/start-stop.yaml + +The command actually executed can be augmented using the wrapper +switch, this allows the test to be run under a debugger or profiler. + +For example to wrap execution under valgrind memory checker + + $ ./test/monkey_driver.py -m ./nsmonkey -w 'valgrind -v --track-origins=yes' -t test/monkey-tests/start-stop.yaml + + +Running more than one test +-------------------------- + +Each test is a member of a group and the tests within each group are +run together. Groups are listed within division index files. A group +of tests may occur within more than one division. + +To run the integration tests the monkey-see-monkey-do python script is +used. It downloads the test plan for a division from the NetSurf test +infrastructure and executes it. + + $ ./test/monkey-see-monkey-do + Fetching tests... + Parsing tests... + Running tests... + Start group: initial + [ Basic checks that the browser can start and stop ] + => Run test: start-stop-no-js.yaml + => Run test: basic-navigation.yaml + => Run test: start-stop.yaml + Start group: no-networking + [ Tests that require no networking ] + => Run test: resource-scheme.yaml + Start group: ecmascript + [ ECMAScript tests ] + PASS + +If no division is specified on the command line the "default" division +is used. Other divisions are specified with the d switch for example +to specify the "short-internet" division: + + $ ./test/monkey-see-monkey-do -d short-internet + +Additionally the g switch allows the limiting of tests within a single +group to be executed. + + $ ./test/monkey-see-monkey-do -g no-networking + Fetching tests... + Parsing tests... + Running tests... + Start group: no-networking + [ Tests that require no networking ] + => Run test: resource-scheme.yaml + PASS + +Test files +---------- + +Each test is a individual [YAML](https://en.wikipedia.org/wiki/YAML) +file and consists of associative arrays (key/value pairs), lists and +comments. + +As a minimum a test must contain an associative array with keys for +`title`, `group` and `steps`. The `steps` key must contain a list of +test operations as a value. + +Each operation is an associative list and must, as a minimum, contain +an action key with a suitable value. + +A minimal test that simply starts the browser without JavaScript and +then quits it without ever opening a window to browse to a page + + title: start and stop browser without JS + group: initial + steps: + - action: launch + options: + - enable_javascript=0 + - action: quit + + +Actions +------- + +### launch + +Start a browser instance. A test will generally have a single launch +action paired with a quit action. + +Additional command line parameters may be set using the `launch-options` +key the value of which must be a list of command line arguments to be +passed to the browser (without their leading hyphens) + +The environment of the browser can be altered with the `environment` key +the value is an associative array of environment variables which will +be added to the browsers environment variables. + +User options may be set using the `options` key with a value containing +a list of options to set. These options allow operation with differing +user choices to be tested without a separate Choices file. + +The `language` key sets the LANGUAGE environment variable which controls +the browsers user interface language. Note this is distinct from the +language the browser requests from HTTP servers which is controlled +with the `accept_language` user option. + +The following launch action would start a browser: + * Passing `--verbose` on the commandline + * The `NETSURFRES` environment variable set to `/home/netsurf/resources` + * The user options `enable_javascript` and `send_referer` set to false. + * The `LANGUAGE` environment variable set to `en` + + - action: launch + launch-options: + - verbose + environment: + NETSURFRES: /home/netsurf/resources + options: + - enable_javascript=0 + - send_referer=0 + language: en + + +### window-new + +Open a new browser window. The test may open as many browser windows +as necessary and they are usually paired with a `window-close` action + +The browser must have been previously launched or this action will +assert the test with a failure. + +The `tag` key *must* also be present with a value (unique for all +window-new actions). The value is used to identify subsequent +operations in this window. + +As an example this will open a new window which can subsequently be +referred to with the win1 identifier: + + - action: window-new + tag: win1 + + +### window-close + +Closes a previously opened window. The window is identified with the +`window` key, the value of this must be a previously created window +identifier or an assert will occur. + + - action: window-close + window: win1 + + +### navigate + +Cause a window to start navigating to a new URL. + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The URL to navigate to navigate to is controlled either by the `url` +or `repeaturl` key. The `url` value is directly used as the address to +navigate to. + + - action: navigate + window: win1 + url: about:about + +The `repeaturl` value is used as a repeat action identifier allowing +navigation in a loop with different values. + + - action: repeat + values: + - https://www.google.com/ + - https://apple.com/ + - https://microsoft.com/ + tag: urls + - action: navigate + window: win1 + repeaturl: urls + + +### reload + +Cause a window to (re)navigate to the current URL + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: reload + window: win1 + +### stop + +Cause a window to immediately stop any navigation. + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: stop + window: win1 + +### sleep-ms + +Wait for time to pass before continuing to next action. + +The value of the `time` key is either the duration to wait for in +milliseconds or a `repeat` action identifier. + +The optional `conditions` key may contain a list of conditionals used +to terminate the delay early. If a `repeat` action identifier is in +use the loop is terminated if a condition is met. + +For example to wait 10 seconds: + + - action: sleep-ms + time: 10000 + +if a repeat action identifier is used the delay duration is the +current iteration value and the delay is timed from when the current +iteration started. + +The `sleep-ms` action here delays by 50 milliseconds more each +iteration until the window navigation is complete when the `sleep-ms` +action is delaying. + + - action: repeat + min: 0 + step: 50 + tag: sleepytimer + steps: + - action: launch + - action: window-new + tag: win1 + - action: navigate + window: win1 + url: about:about + - action: sleep-ms + time: sleepytimer + conditions: + - window: win1 + status: complete + - action: quit + + +### block + +Wait for conditions to be met before continuing. This is similar to +the `sleep-ms` action except that it will wait forever for the +conditions to be met. + +The `conditions` key must contain a list of conditionals used to +terminate the block. + + - action: block + conditions: + - window: win1 + status: complete + + +### repeat + +Repeat a set of actions. + +The identifier of the repeat action is set with the `tag` key and must +be present and unique among `repeat` action identifiers. + +The actions to be repeated are placed in the `steps` list which may +include any action and behaves just like the top level list. + +An iterator context is created for the repeat loop. The iterator can +either be configured as a numeric value or as a list of values. + +The numeric iterator is controlled with the `min` ,`step` and `max` +keys. All these keys are integer values and their presence is +optional. + +The `min` value is the initial value of the iterator which defaults +to 0. + +The `step` value controls how much the iterator is incremented +on every loop with default value of 1. + +The loop terminates if the `max` value is exceeded. If no `max` value +is specified the loop is infinite (i.e. no default) but may still be +terminated by the `sleep-ms` action + + - action: repeat + min: 0 + step: 50 + max: 100 + tag: loopvar + steps: + - action: launch + - action: quit + +A value iterator has a `values` key containing a list. On each +iteration of the loop a new value is available and can be used by the +`navigate` action. + +Note that `min` ,`step` and `max` are ignored if there is a `values` key + + - action: repeat + values: + - https://www.google.com/ + - https://www.blogger.com/ + - https://apple.com/ + - https://microsoft.com/ + tag: urls + steps: + - action: navigate + window: win1 + repeaturl: urls + - action: block + conditions: + - window: win1 + status: complete + + +### timer-start + +Start a timer. + +The identifier for the timer is set with the `timer` key. + + - action: timer-start + timer: timer1 + + +### timer-restart + +Re-start a timer + +The identifier for the timer is set with the `timer` key. + + - action: timer-restart + timer: timer1 + +### timer-stop + +Stop a timer + +The identifier for the timer is set with the `timer` key. + + - action: timer-stop + timer: timer1 + + +### timer-check + +Check a timer meets a condition. + +The identifier for the timer is set with the `timer` key. + +The conditional is set with the `condition` key which must be present. + + +### plot-check + +Perform a plot of a previously navigated window. + +The window to be rendered is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +An optional list of checks may be specified with the `checks` key. If +any check is not satisfied an assert will occur and the test will +fail. + +The checks available are: + + * The key `text-contains` where the text must occur somewhere in the + plotted output. + * The key `text-not-contains` where the text must not occur in the + plotted output. + * The key `bitmap-count` which specifies the number of images that + must be present. + + + - action: plot-check + window: win1 + checks: + - text-contains: NetSurf + - text-not-contains: Chrome + - bitmap-count: 1 + + +### click + +Perform a user mouse click on a specified window. + +The window to be clicked is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The `target` key contains an associative array which is used to select +the location of the mouse operation in the window. The key `text` can +be used to select text to be operated upon which matches the first +occurrence of the text. The key `bitmap` has an integer value to +select the index of the image to click. + +The optional `button` key selects which button is pressed it can take +the value `left` or `right`. The default if not specified is `left` + +The optional `kind` key selects which button operation to be performed +it can take the value `single`, `double` or `triple`. The default if +not specified is `single` + + - action: click + window: win1 + target: + text: "about:Choices" + + +### wait-loading + +Wait for the navigated page to start loading before moving to the next +action. + +The window to be waited upon is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: wait-loading + window: win1 + + +### add-auth + +Add basic authentication details for a navigation. + +The keys `url`, `realm`, `username` and `password` must be given. When +a basic authentication challenge occurs that matches the url and +realm parameters the associated username and password are returned to +answer the challenge. + + - action: add-auth + url: http://test.netsurf-browser.org/cgi-bin/auth.cgi?user=foo&pass=bar + realm: Fake Realm + username: foo + password: bar + + +### remove-auth + +Remove a previously added authentication details. + + - action: remove-auth + url: http://test.netsurf-browser.org/cgi-bin/auth.cgi?user=foo&pass=bar + realm: Fake Realm + username: foo + password: bar + + +### add-cert + +Add certificate error handler for a url. + + +### remove-cert + +Remove certificate error handler for a url. + + +### clear-log + +Clear log for a window. + +The window to be cleared is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + +### wait-log + +Wait for string to appear in log output. + +The window to be waited upon is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The keys `source` `foldable` `level` and `substring` must be specified + +### js-exec + +Execute javascript in a window. + +The window to be execute within is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The `cmd` key contains the javascript to execute. + + +### page-info-state + +Check the page information status matches an expected value. + +The window to be checked is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The value of the `match` key is compared to the windows page +information status and an assert occurs if there is a mismatch. + +### quit + +This causes a previously launched browser instance to exit cleanly. commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=e070f13093a23ea7ac9... commit e070f13093a23ea7ac962fffd3d1821ced9894e3 Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; integration test remove remaining windows when browser has been quit diff --git a/test/monkey_driver.py b/test/monkey_driver.py index 62d5766..fe904d3 100755 --- a/test/monkey_driver.py +++ b/test/monkey_driver.py @@ -643,6 +643,8 @@ def run_test_step_action_quit(ctx, step): assert_browser(ctx) browser = ctx.pop('browser') assert browser.quit_and_wait() + # clean up context as all windows have gone away after browser quit + ctx.pop('windows') STEP_HANDLERS = { commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=710818f346a35facadc... commit 710818f346a35facadc28cd1f25824d99ca72306 Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; fix integration test repeat "max" handling diff --git a/test/monkey_driver.py b/test/monkey_driver.py index 7a2871d..62d5766 100755 --- a/test/monkey_driver.py +++ b/test/monkey_driver.py @@ -374,32 +374,50 @@ def run_test_step_action_repeat(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) tag = step['tag'] assert ctx['repeats'].get(tag) is None + # initialise the loop continue conditional ctx['repeats'][tag] = {"loop": True, } - if 'min' in step.keys(): - ctx['repeats'][tag]["i"] = step["min"] - else: - ctx['repeats'][tag]["i"] = 0 - - if 'step' in step.keys(): - ctx['repeats'][tag]["step"] = step["step"] - else: - ctx['repeats'][tag]["step"] = 1 - if 'values' in step.keys(): + # value iterator ctx['repeats'][tag]['values'] = step["values"] + ctx['repeats'][tag]["max"] = len(step["values"]) + ctx['repeats'][tag]["i"] = 0 + ctx['repeats'][tag]["step"] = 1 else: + # numeric iterator ctx['repeats'][tag]['values'] = None + if 'min' in step.keys(): + ctx['repeats'][tag]["i"] = step["min"] + else: + ctx['repeats'][tag]["i"] = 0 + + if 'step' in step.keys(): + ctx['repeats'][tag]["step"] = step["step"] + else: + ctx['repeats'][tag]["step"] = 1 + + if 'max' in step.keys(): + ctx['repeats'][tag]["max"] = step["max"] + else: + ctx['repeats'][tag]["max"] = None + while ctx['repeats'][tag]["loop"]: ctx['repeats'][tag]["start"] = time.time() ctx["depth"] += 1 + + # run through steps for this iteration for stp in step["steps"]: run_test_step(ctx, stp) + + # increment iterator ctx['repeats'][tag]["i"] += ctx['repeats'][tag]["step"] - if ctx['repeats'][tag]['values'] is not None: - if ctx['repeats'][tag]["i"] >= len(ctx['repeats'][tag]['values']): + + # check for end condition + if ctx['repeats'][tag]["max"] is not None: + if ctx['repeats'][tag]["i"] >= ctx['repeats'][tag]["max"]: ctx['repeats'][tag]["loop"] = False + ctx["depth"] -= 1 commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=9cb7d0ab4844cbc79e6... commit 9cb7d0ab4844cbc79e6d2937306fdb0501af4fef Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; make conditionals optional in integration test sleep-ms action diff --git a/test/monkey_driver.py b/test/monkey_driver.py index a0f4f36..7a2871d 100755 --- a/test/monkey_driver.py +++ b/test/monkey_driver.py @@ -333,7 +333,7 @@ def run_test_step_action_reload(ctx, step): def run_test_step_action_sleep_ms(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) - conds = step['conditions'] + conds = step.get('conditions', {}) sleep_time = step['time'] sleep = 0 have_repeat = False commitdiff http://git.netsurf-browser.org/netsurf.git/commit/?id=19dded8cfa7a7772d5a... commit 19dded8cfa7a7772d5a6ece3e5b975c142e85456 Author: Vincent Sanders <vince(a)kyllikki.org&gt; Commit: Vincent Sanders <vince(a)kyllikki.org&gt; add ability for monkey farmer to launch browser with environment variables set diff --git a/test/monkey_driver.py b/test/monkey_driver.py index 0a9e29a..a0f4f36 100755 --- a/test/monkey_driver.py +++ b/test/monkey_driver.py @@ -22,6 +22,7 @@ runs tests in monkey as defined in a yaml file # pylint: disable=locally-disabled, missing-docstring +import os import sys import getopt import time @@ -232,18 +233,35 @@ def conds_met(ctx, conds): def run_test_step_action_launch(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) + + # ensure browser is not already launched assert ctx.get('browser') is None assert ctx.get('windows') is None + + # build command line switches list monkey_cmd = [ctx["monkey"]] for option in step.get('launch-options', []): monkey_cmd.append("--{}".format(option)) print(get_indent(ctx) + " " + "Command line: " + repr(monkey_cmd)) + + # build command environment + monkey_env = os.environ.copy() + for envkey, envvalue in step.get('environment', {}).items(): + monkey_env[envkey] = envvalue + print(get_indent(ctx) + " " + envkey + "=" + envvalue) + if 'language' in step.keys(): + monkey_env['LANGUAGE'] = step['language'] + + # create browser object ctx['browser'] = DriverBrowser( monkey_cmd=monkey_cmd, + monkey_env=monkey_env, quiet=True, wrapper=ctx.get("wrapper")) assert_browser(ctx) ctx['windows'] = dict() + + # set user options for option in step.get('options', []): print(get_indent(ctx) + " " + option) ctx['browser'].pass_options(option) diff --git a/test/monkeyfarmer.py b/test/monkeyfarmer.py index fbcd748..c246876 100644 --- a/test/monkeyfarmer.py +++ b/test/monkeyfarmer.py @@ -75,7 +75,7 @@ class MonkeyFarmer(asyncore.dispatcher): # pylint: disable=locally-disabled, too-many-instance-attributes - def __init__(self, monkey_cmd, online, quiet=False, *, wrapper=None): + def __init__(self, monkey_cmd, monkey_env, online, quiet=False, *, wrapper=None): (mine, monkeys) = socket.socketpair() asyncore.dispatcher.__init__(self, sock=mine) @@ -91,6 +91,7 @@ class MonkeyFarmer(asyncore.dispatcher): self.monkey = subprocess.Popen( monkey_cmd, + env=monkey_env, stdin=monkeys, stdout=monkeys, stderr=monkeyserr, @@ -206,9 +207,10 @@ class Browser: # pylint: disable=locally-disabled, too-many-instance-attributes, dangerous-default-value, invalid-name - def __init__(self, monkey_cmd=["./nsmonkey"], quiet=False, *, wrapper=None): + def __init__(self, monkey_cmd=["./nsmonkey"], monkey_env=None, quiet=False, *, wrapper=None): self.farmer = MonkeyFarmer( monkey_cmd=monkey_cmd, + monkey_env=monkey_env, online=self.on_monkey_line, quiet=quiet, wrapper=wrapper) ----------------------------------------------------------------------- Summary of changes: docs/development.md | 44 +-- docs/integration-testing.md | 545 +++++++++++++++++++++++++++++++ test/monkey-tests/start-stop-no-js.yaml | 5 +- test/monkey_driver.py | 64 +++- test/monkeyfarmer.py | 6 +- 5 files changed, 605 insertions(+), 59 deletions(-) create mode 100644 docs/integration-testing.md diff --git a/docs/development.md b/docs/development.md index c9268d4..5a8d1aa 100644 --- a/docs/development.md +++ b/docs/development.md @@ -65,47 +65,9 @@ functions. # Integration testing -The monkey frontend is used to perform complex tests involving -operating the browser as a user might (opening windows, navigating to -websites and rendering the contents etc.) - -A test is written as a set of operations in a yaml file. A test can be -run using the monkey_driver.py python script - - $ ./test/monkey_driver.py -m ./nsmonkey -t test/monkey-tests/start-stop.yaml - -There are very few tests within the netsurf repository. The large -majority of integration tests are held within the -[netsurf-test](http://source.netsurf-browser.org/netsurf-test.git/) -repository. - -To allow more effective use of these tests additional infrastructure -has been constructed to allow groupings of tests to be run. This is -used extensively by the CI system to perform integration testing on -every commit. - -Each test is a member of a group and the tests within each group are -run together. Groups are listed within division index files. To run -the integration tests the monkey-see-monkey-do python script is -used. It downloads the test plan for a division from the netsurf test -infrastructrure and executes it. - - $ ./test/monkey-see-monkey-do - Fetching tests... - Parsing tests... - Running tests... - Start group: initial - [ Basic checks that the browser can start and stop ] - => Run test: start-stop-no-js.yaml - => Run test: basic-navigation.yaml - => Run test: start-stop.yaml - Start group: no-networking - [ Tests that require no networking ] - => Run test: resource-scheme.yaml - Start group: ecmascript - [ ECMAScript tests ] - PASS - +NetSurf [integration tests](docs/integration-testing.md) use the +monkey frontend to operate the browser as a whole. These tests open +windows, navigate to websites and render contents as a user might. # Documented API diff --git a/docs/integration-testing.md b/docs/integration-testing.md new file mode 100644 index 0000000..defcc17 --- /dev/null +++ b/docs/integration-testing.md @@ -0,0 +1,545 @@ +NetSurf Integration Testing +=========================== + +Overview +-------- + +The monkey frontend is used to perform complex tests involving +operating the browser as a user might (opening windows, navigating to +websites and rendering the contents etc.) + +A test is written as a set of operations in a yaml file. These files +are parsed and executed by the monkey driver script. + +There are very few tests within the NetSurf repository. The large +majority of integration tests are instead held within the +[netsurf-test](http://source.netsurf-browser.org/netsurf-test.git/) +repository. + +To allow more effective use of these tests additional infrastructure +has been constructed to allow groupings of tests to be run. This is +used extensively by the CI system to perform integration testing on +every commit. + +The infrastructure also provides for special CGI scripts which have +known behaviours such as delays or returning specific content to +extend test capabilities. + + +Running a test +-------------- + +An individual test can be run using the monkey_driver.py python script +from within the NetSurf repository + + $ make TARGET=monkey + $ ./test/monkey_driver.py -m ./nsmonkey -t test/monkey-tests/start-stop.yaml + +The command actually executed can be augmented using the wrapper +switch, this allows the test to be run under a debugger or profiler. + +For example to wrap execution under valgrind memory checker + + $ ./test/monkey_driver.py -m ./nsmonkey -w 'valgrind -v --track-origins=yes' -t test/monkey-tests/start-stop.yaml + + +Running more than one test +-------------------------- + +Each test is a member of a group and the tests within each group are +run together. Groups are listed within division index files. A group +of tests may occur within more than one division. + +To run the integration tests the monkey-see-monkey-do python script is +used. It downloads the test plan for a division from the NetSurf test +infrastructure and executes it. + + $ ./test/monkey-see-monkey-do + Fetching tests... + Parsing tests... + Running tests... + Start group: initial + [ Basic checks that the browser can start and stop ] + => Run test: start-stop-no-js.yaml + => Run test: basic-navigation.yaml + => Run test: start-stop.yaml + Start group: no-networking + [ Tests that require no networking ] + => Run test: resource-scheme.yaml + Start group: ecmascript + [ ECMAScript tests ] + PASS + +If no division is specified on the command line the "default" division +is used. Other divisions are specified with the d switch for example +to specify the "short-internet" division: + + $ ./test/monkey-see-monkey-do -d short-internet + +Additionally the g switch allows the limiting of tests within a single +group to be executed. + + $ ./test/monkey-see-monkey-do -g no-networking + Fetching tests... + Parsing tests... + Running tests... + Start group: no-networking + [ Tests that require no networking ] + => Run test: resource-scheme.yaml + PASS + +Test files +---------- + +Each test is a individual [YAML](https://en.wikipedia.org/wiki/YAML) +file and consists of associative arrays (key/value pairs), lists and +comments. + +As a minimum a test must contain an associative array with keys for +`title`, `group` and `steps`. The `steps` key must contain a list of +test operations as a value. + +Each operation is an associative list and must, as a minimum, contain +an action key with a suitable value. + +A minimal test that simply starts the browser without JavaScript and +then quits it without ever opening a window to browse to a page + + title: start and stop browser without JS + group: initial + steps: + - action: launch + options: + - enable_javascript=0 + - action: quit + + +Actions +------- + +### launch + +Start a browser instance. A test will generally have a single launch +action paired with a quit action. + +Additional command line parameters may be set using the `launch-options` +key the value of which must be a list of command line arguments to be +passed to the browser (without their leading hyphens) + +The environment of the browser can be altered with the `environment` key +the value is an associative array of environment variables which will +be added to the browsers environment variables. + +User options may be set using the `options` key with a value containing +a list of options to set. These options allow operation with differing +user choices to be tested without a separate Choices file. + +The `language` key sets the LANGUAGE environment variable which controls +the browsers user interface language. Note this is distinct from the +language the browser requests from HTTP servers which is controlled +with the `accept_language` user option. + +The following launch action would start a browser: + * Passing `--verbose` on the commandline + * The `NETSURFRES` environment variable set to `/home/netsurf/resources` + * The user options `enable_javascript` and `send_referer` set to false. + * The `LANGUAGE` environment variable set to `en` + + - action: launch + launch-options: + - verbose + environment: + NETSURFRES: /home/netsurf/resources + options: + - enable_javascript=0 + - send_referer=0 + language: en + + +### window-new + +Open a new browser window. The test may open as many browser windows +as necessary and they are usually paired with a `window-close` action + +The browser must have been previously launched or this action will +assert the test with a failure. + +The `tag` key *must* also be present with a value (unique for all +window-new actions). The value is used to identify subsequent +operations in this window. + +As an example this will open a new window which can subsequently be +referred to with the win1 identifier: + + - action: window-new + tag: win1 + + +### window-close + +Closes a previously opened window. The window is identified with the +`window` key, the value of this must be a previously created window +identifier or an assert will occur. + + - action: window-close + window: win1 + + +### navigate + +Cause a window to start navigating to a new URL. + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The URL to navigate to navigate to is controlled either by the `url` +or `repeaturl` key. The `url` value is directly used as the address to +navigate to. + + - action: navigate + window: win1 + url: about:about + +The `repeaturl` value is used as a repeat action identifier allowing +navigation in a loop with different values. + + - action: repeat + values: + - https://www.google.com/ + - https://apple.com/ + - https://microsoft.com/ + tag: urls + - action: navigate + window: win1 + repeaturl: urls + + +### reload + +Cause a window to (re)navigate to the current URL + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: reload + window: win1 + +### stop + +Cause a window to immediately stop any navigation. + +The window to be navigated is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: stop + window: win1 + +### sleep-ms + +Wait for time to pass before continuing to next action. + +The value of the `time` key is either the duration to wait for in +milliseconds or a `repeat` action identifier. + +The optional `conditions` key may contain a list of conditionals used +to terminate the delay early. If a `repeat` action identifier is in +use the loop is terminated if a condition is met. + +For example to wait 10 seconds: + + - action: sleep-ms + time: 10000 + +if a repeat action identifier is used the delay duration is the +current iteration value and the delay is timed from when the current +iteration started. + +The `sleep-ms` action here delays by 50 milliseconds more each +iteration until the window navigation is complete when the `sleep-ms` +action is delaying. + + - action: repeat + min: 0 + step: 50 + tag: sleepytimer + steps: + - action: launch + - action: window-new + tag: win1 + - action: navigate + window: win1 + url: about:about + - action: sleep-ms + time: sleepytimer + conditions: + - window: win1 + status: complete + - action: quit + + +### block + +Wait for conditions to be met before continuing. This is similar to +the `sleep-ms` action except that it will wait forever for the +conditions to be met. + +The `conditions` key must contain a list of conditionals used to +terminate the block. + + - action: block + conditions: + - window: win1 + status: complete + + +### repeat + +Repeat a set of actions. + +The identifier of the repeat action is set with the `tag` key and must +be present and unique among `repeat` action identifiers. + +The actions to be repeated are placed in the `steps` list which may +include any action and behaves just like the top level list. + +An iterator context is created for the repeat loop. The iterator can +either be configured as a numeric value or as a list of values. + +The numeric iterator is controlled with the `min` ,`step` and `max` +keys. All these keys are integer values and their presence is +optional. + +The `min` value is the initial value of the iterator which defaults +to 0. + +The `step` value controls how much the iterator is incremented +on every loop with default value of 1. + +The loop terminates if the `max` value is exceeded. If no `max` value +is specified the loop is infinite (i.e. no default) but may still be +terminated by the `sleep-ms` action + + - action: repeat + min: 0 + step: 50 + max: 100 + tag: loopvar + steps: + - action: launch + - action: quit + +A value iterator has a `values` key containing a list. On each +iteration of the loop a new value is available and can be used by the +`navigate` action. + +Note that `min` ,`step` and `max` are ignored if there is a `values` key + + - action: repeat + values: + - https://www.google.com/ + - https://www.blogger.com/ + - https://apple.com/ + - https://microsoft.com/ + tag: urls + steps: + - action: navigate + window: win1 + repeaturl: urls + - action: block + conditions: + - window: win1 + status: complete + + +### timer-start + +Start a timer. + +The identifier for the timer is set with the `timer` key. + + - action: timer-start + timer: timer1 + + +### timer-restart + +Re-start a timer + +The identifier for the timer is set with the `timer` key. + + - action: timer-restart + timer: timer1 + +### timer-stop + +Stop a timer + +The identifier for the timer is set with the `timer` key. + + - action: timer-stop + timer: timer1 + + +### timer-check + +Check a timer meets a condition. + +The identifier for the timer is set with the `timer` key. + +The conditional is set with the `condition` key which must be present. + + +### plot-check + +Perform a plot of a previously navigated window. + +The window to be rendered is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +An optional list of checks may be specified with the `checks` key. If +any check is not satisfied an assert will occur and the test will +fail. + +The checks available are: + + * The key `text-contains` where the text must occur somewhere in the + plotted output. + * The key `text-not-contains` where the text must not occur in the + plotted output. + * The key `bitmap-count` which specifies the number of images that + must be present. + + + - action: plot-check + window: win1 + checks: + - text-contains: NetSurf + - text-not-contains: Chrome + - bitmap-count: 1 + + +### click + +Perform a user mouse click on a specified window. + +The window to be clicked is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The `target` key contains an associative array which is used to select +the location of the mouse operation in the window. The key `text` can +be used to select text to be operated upon which matches the first +occurrence of the text. The key `bitmap` has an integer value to +select the index of the image to click. + +The optional `button` key selects which button is pressed it can take +the value `left` or `right`. The default if not specified is `left` + +The optional `kind` key selects which button operation to be performed +it can take the value `single`, `double` or `triple`. The default if +not specified is `single` + + - action: click + window: win1 + target: + text: "about:Choices" + + +### wait-loading + +Wait for the navigated page to start loading before moving to the next +action. + +The window to be waited upon is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + - action: wait-loading + window: win1 + + +### add-auth + +Add basic authentication details for a navigation. + +The keys `url`, `realm`, `username` and `password` must be given. When +a basic authentication challenge occurs that matches the url and +realm parameters the associated username and password are returned to +answer the challenge. + + - action: add-auth + url: http://test.netsurf-browser.org/cgi-bin/auth.cgi?user=foo&pass=bar + realm: Fake Realm + username: foo + password: bar + + +### remove-auth + +Remove a previously added authentication details. + + - action: remove-auth + url: http://test.netsurf-browser.org/cgi-bin/auth.cgi?user=foo&pass=bar + realm: Fake Realm + username: foo + password: bar + + +### add-cert + +Add certificate error handler for a url. + + +### remove-cert + +Remove certificate error handler for a url. + + +### clear-log + +Clear log for a window. + +The window to be cleared is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + + +### wait-log + +Wait for string to appear in log output. + +The window to be waited upon is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The keys `source` `foldable` `level` and `substring` must be specified + +### js-exec + +Execute javascript in a window. + +The window to be execute within is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The `cmd` key contains the javascript to execute. + + +### page-info-state + +Check the page information status matches an expected value. + +The window to be checked is identified with the `window` key, the +value of this must be a previously created window identifier or an +assert will occur. + +The value of the `match` key is compared to the windows page +information status and an assert occurs if there is a mismatch. + +### quit + +This causes a previously launched browser instance to exit cleanly. diff --git a/test/monkey-tests/start-stop-no-js.yaml b/test/monkey-tests/start-stop-no-js.yaml index 0a681cf..028e08f 100644 --- a/test/monkey-tests/start-stop-no-js.yaml +++ b/test/monkey-tests/start-stop-no-js.yaml @@ -1,8 +1,7 @@ title: start and stop browser without JS -group: basic +group: initial steps: - action: launch - args: + options: - enable_javascript=0 - action: quit - diff --git a/test/monkey_driver.py b/test/monkey_driver.py index 0a9e29a..fe904d3 100755 --- a/test/monkey_driver.py +++ b/test/monkey_driver.py @@ -22,6 +22,7 @@ runs tests in monkey as defined in a yaml file # pylint: disable=locally-disabled, missing-docstring +import os import sys import getopt import time @@ -232,18 +233,35 @@ def conds_met(ctx, conds): def run_test_step_action_launch(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) + + # ensure browser is not already launched assert ctx.get('browser') is None assert ctx.get('windows') is None + + # build command line switches list monkey_cmd = [ctx["monkey"]] for option in step.get('launch-options', []): monkey_cmd.append("--{}".format(option)) print(get_indent(ctx) + " " + "Command line: " + repr(monkey_cmd)) + + # build command environment + monkey_env = os.environ.copy() + for envkey, envvalue in step.get('environment', {}).items(): + monkey_env[envkey] = envvalue + print(get_indent(ctx) + " " + envkey + "=" + envvalue) + if 'language' in step.keys(): + monkey_env['LANGUAGE'] = step['language'] + + # create browser object ctx['browser'] = DriverBrowser( monkey_cmd=monkey_cmd, + monkey_env=monkey_env, quiet=True, wrapper=ctx.get("wrapper")) assert_browser(ctx) ctx['windows'] = dict() + + # set user options for option in step.get('options', []): print(get_indent(ctx) + " " + option) ctx['browser'].pass_options(option) @@ -315,7 +333,7 @@ def run_test_step_action_reload(ctx, step): def run_test_step_action_sleep_ms(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) - conds = step['conditions'] + conds = step.get('conditions', {}) sleep_time = step['time'] sleep = 0 have_repeat = False @@ -356,32 +374,50 @@ def run_test_step_action_repeat(ctx, step): print(get_indent(ctx) + "Action: " + step["action"]) tag = step['tag'] assert ctx['repeats'].get(tag) is None + # initialise the loop continue conditional ctx['repeats'][tag] = {"loop": True, } - if 'min' in step.keys(): - ctx['repeats'][tag]["i"] = step["min"] - else: - ctx['repeats'][tag]["i"] = 0 - - if 'step' in step.keys(): - ctx['repeats'][tag]["step"] = step["step"] - else: - ctx['repeats'][tag]["step"] = 1 - if 'values' in step.keys(): + # value iterator ctx['repeats'][tag]['values'] = step["values"] + ctx['repeats'][tag]["max"] = len(step["values"]) + ctx['repeats'][tag]["i"] = 0 + ctx['repeats'][tag]["step"] = 1 else: + # numeric iterator ctx['repeats'][tag]['values'] = None + if 'min' in step.keys(): + ctx['repeats'][tag]["i"] = step["min"] + else: + ctx['repeats'][tag]["i"] = 0 + + if 'step' in step.keys(): + ctx['repeats'][tag]["step"] = step["step"] + else: + ctx['repeats'][tag]["step"] = 1 + + if 'max' in step.keys(): + ctx['repeats'][tag]["max"] = step["max"] + else: + ctx['repeats'][tag]["max"] = None + while ctx['repeats'][tag]["loop"]: ctx['repeats'][tag]["start"] = time.time() ctx["depth"] += 1 + + # run through steps for this iteration for stp in step["steps"]: run_test_step(ctx, stp) + + # increment iterator ctx['repeats'][tag]["i"] += ctx['repeats'][tag]["step"] - if ctx['repeats'][tag]['values'] is not None: - if ctx['repeats'][tag]["i"] >= len(ctx['repeats'][tag]['values']): + + # check for end condition + if ctx['repeats'][tag]["max"] is not None: + if ctx['repeats'][tag]["i"] >= ctx['repeats'][tag]["max"]: ctx['repeats'][tag]["loop"] = False + ctx["depth"] -= 1 @@ -607,6 +643,8 @@ def run_test_step_action_quit(ctx, step): assert_browser(ctx) browser = ctx.pop('browser') assert browser.quit_and_wait() + # clean up context as all windows have gone away after browser quit + ctx.pop('windows') STEP_HANDLERS = { diff --git a/test/monkeyfarmer.py b/test/monkeyfarmer.py index fbcd748..c246876 100644 --- a/test/monkeyfarmer.py +++ b/test/monkeyfarmer.py @@ -75,7 +75,7 @@ class MonkeyFarmer(asyncore.dispatcher): # pylint: disable=locally-disabled, too-many-instance-attributes - def __init__(self, monkey_cmd, online, quiet=False, *, wrapper=None): + def __init__(self, monkey_cmd, monkey_env, online, quiet=False, *, wrapper=None): (mine, monkeys) = socket.socketpair() asyncore.dispatcher.__init__(self, sock=mine) @@ -91,6 +91,7 @@ class MonkeyFarmer(asyncore.dispatcher): self.monkey = subprocess.Popen( monkey_cmd, + env=monkey_env, stdin=monkeys, stdout=monkeys, stderr=monkeyserr, @@ -206,9 +207,10 @@ class Browser: # pylint: disable=locally-disabled, too-many-instance-attributes, dangerous-default-value, invalid-name - def __init__(self, monkey_cmd=["./nsmonkey"], quiet=False, *, wrapper=None): + def __init__(self, monkey_cmd=["./nsmonkey"], monkey_env=None, quiet=False, *, wrapper=None): self.farmer = MonkeyFarmer( monkey_cmd=monkey_cmd, + monkey_env=monkey_env, online=self.on_monkey_line, quiet=quiet, wrapper=wrapper) -- NetSurf Browser