Changes between Version 1 and Version 2 of DeveloperGuidelines/Testing/Roles

Timestamp:

08/21/13 23:20:06 (12 years ago)

Author:

Michael Howden

Comment:

--

DeveloperGuidelines/Testing/Roles

@@ -20 +20 @@
 }}}
 
-== Information About the Test Suite ==
+== Writing Role Tests for a Template ==
 
-=== Location ===
+To write role tests for a template, you will need to create a folder for that template in the role test folder: {{{modules/tests/roles/<template_name>}}}. In this folder you'll have to create the following files. 
 
+=== organisations ===
+{{{<template_name>/organisations.xml}}}[[BR]]
+This file will specify which organisations & branches data & users are created for.
+
+
+=== data ===
+{{{<template_name>/data.xml}}}[[BR]]
+This file will define the data that will be created for the user's roles will be tested against. See existing examples and [wiki:S3XML#XMLFormat] for how to format this file. This file will include the string {{{%(org)s}}} which will be replaced with the name of the organisation/branch.
+
+=== users template ===
+{{{<template_name>/users_template.csv}}}[[BR]]
+A file template for the users and roles which will be tested. See existing examples for how to format this file. This file will include the string {{{%(org)s}}} which will be replaced with the name of the organisation/branch. To assign a role for an organisation, using this syntax: {{{<role_name>/org_organisation.name=%(org)s}}}.
+
+=== Test Users (optional) ===
+{{{<template_name>/test_users.csv}}}[[BR]]
+An optional file which is used to create users - handy for debugging.
+
+=== Permission Matrix ===
+{{{<template_name>/Org-A_permission_matrix.csv}}}[[BR]]
+The permissions declared in this file are tested upon. Currently permissions are only tested for users from Org-A, but you can test their access to data from other Organisations.
+
+== Role Test Documentation  ==
 The tests are located in {{{modules/tests/roles/}}}
-
-The template specific files are located in {{{modules/tests/roles/<template_name>}}}
-
-=== Files ===
-
+Files:
 * The file {{{modules/tests/roles/test_roles.py}}} tests permissions against role matrix file.
 * The data for the roles tests is created by {{{modules/tests/roles/create_role_test_data.py}}}
- * It depends on the following for creating the data - 
-  * {{{org_organisation.xml}}} - A generic file for all templates. It is used for importing the organisation.
-  * {{{org_organisation_branch.xml}}} - A generic file for all templates. It is used for importing the organisation branches, if the template uses branches.
-  * {{{<template_name>/data.xml}}} - A file template for the data which the user's roles will be tested against.
-  * {{{<template_name>/users_template.csv}}} - A file template for the users and roles which will be tested.
-  * {{{<template_name>/test_users.csv}}} - An optional file which is used to create users - handy for debugging.
-* The user permissions are defined in {{{<template_name>/Org-A_permission_matrix.csv}}}. The permissions declared in this file are tested upon.
 
+