4.7. Administration

The ADMIN tab allows administrators to manage:

  • Entities
  • Group and user permissions
  • Test Plans and Test Cases
  • Bug tracking systems
  • and more ...

The Administration screen

4.7.1. Configure Kiwi’s base URL

The first step you need to do is configure the base URL of your KiwiTestPad installation. This is used to construct links to test plans, test cases, etc. The default value is 127.0.0.1:8000 which is suitable if you are running in devel mode. To update the setting go to http://<your_domain_or_ip>/admin/sites/site/1/! In the text field enter the domain name or IR address, including port if necessary and click the Save button!

4.7.2. Adding bug trackers

One of the first steps when working with KiwiTestPad is to configure bug tracking systems. This can be done via the interface located via the menu ADMIN -> Test cases -> Bug trackers. Each bug tracker is given a name, short description, URL format string and a regular expression which is used to validate bug ID strings sent from the user.

Users can add or remove bugs to test cases and test case runs if they have the testcases.add_testcasebug and/or testcases.delete_testcasebug permissions!

4.7.3. Managing permissions

The Auth administration section covers Groups and Users.

The Auth screen

4.7.3.1. Groups

KiwiTestPad uses groups to manage access to parts of the system. Groups have two fields: name and permissions. By default there are two groups created

  • Administrator - has all available permissions;
  • Tester - has all available permissions from the django_comments, management, testcases, testruns and testplans applications.

4.7.3.1.1. Adding a group

A group requires a name and a set of permissions.

4.7.3.1.1.1. Procedure: Adding a group

To add a group:

  1. From the ADMIN menu, click Auth.

    The Admin menu 1

  2. Click Groups, then click Add Group.

    The Add group link

  3. In the add group screen, perform the following actions:

    • Enter the Group Name.
    • From Available permissions, select the Group’s permissions.
  4. Click Add.

    The Add Group button

    The Chosen permissions list is updated.

  5. Click Save.

4.7.3.1.2. Editing a group

The group name can be changed. Permissions can be added or removed.

4.7.3.1.2.1. Procedure: Editing a group

To edit a group:

  1. From the ADMIN menu, click Auth.
  2. Click Groups.
  3. From the Group list, click the group to edit.
  4. Select the permission required. Click Add or Remove as required.
  5. Click Save.

4.7.3.2. Users

4.7.3.2.1. Assigning administrator rights

A user with administrator rights can access the ADMIN tab.

4.7.3.2.1.1. Procedure: Assigning administrator rights

To assign administrator rights:

  1. From the ADMIN menu, click Auth.

  2. Click Users.

  3. In the Search Bar, enter the username, and then click Search.

  4. Click the Username.

  5. In the Permissions screen, select Staff status.

    The Staff Status check box

  6. Click Save. The Staff Status icon changes to a green tick.

Note

If the user requires full permissions, select Superuser status.

4.7.3.2.2. Assigning permissions

User permissions can be granted or revoked for individual components of KiwiTestPad. All permissions are prefixed with the add_, change_ and delete_ prefixes signifying the operation which is controlled by this permission. Then the codename contains the name of the model for which this permission applies. For example, the ability to add attachments to a Test Case is controlled via the add_testcaseattachment permission.

4.7.3.2.2.1. Procedure: Assigning permissions

To assign permissions:

  1. From the ADMIN menu, click Auth.
  2. Click Users.
  3. In the Search Bar, enter the username, and then click Search.
  4. Click the Username.
  5. In the User permission screen:
    • To add permissions, select the permissions to be granted, and then click Add.
    • To remove permissions, select the permissions to be revoked, and then click Remove.
  6. Click Save.

4.7.3.2.3. Adding a user to a group

Group permissions in KiwiTestPad work the same as they do in Linux. The system checks a user’s personal permissions, then group permissions.

4.7.3.2.3.1. Procedure: Adding a user to a group

To add a user to a group:

  1. From the ADMIN menu, click Auth.
  2. Click Users.
  3. In the Search Bar, enter the username, and then click Search.
  4. Click the Username.
  5. From Groups select the user to add.
  6. Click Save.

4.7.3.2.4. Updating personal information

KiwiTestPad can store email, first and last name details of a user.

4.7.3.2.4.1. Procedure: Updating personal information

To update personal information:

  1. From the ADMIN menu, click Auth.
  2. Click Users.
  3. In the Search Bar, enter the username, and then click Search.
  4. Click the Username.
  5. From Personal Information edit:
    • First Name
    • Last Name
    • Email Address
  6. Click Save.

4.7.3.2.5. Deleting a user

Users can not be deleted from KiwiTestPad. A user that is no longer required must be disabled.

4.7.3.2.5.1. Procedure: Disabling a user

To disable a user:

  1. From the ADMIN menu, click Auth.

  2. Click Users.

  3. In the Search Bar, enter the username, and then click Search.

  4. Click the Username.

  5. Untick the Active checkbox.

    The Active checkbox

  6. Click Save.

4.7.3.3. Access Control Lists

KiwiTestPad uses ACLs for the user groups: Guest, Tester, and Admin. The permissions for each group can be controlled from the Group section in the AUTH tab.

Default ACLs in the TCMS.

Group Test Plan Test Case Environment Administration
Guest Read Read
Tester Read / Write Read / Write Read / Write
Administrator Read / Write Read / Write Read / Write Read / Write

4.7.4. Managing entities

The following entities are listed in KiwiTestPad:

  • Builds
  • Classifications
  • Components
  • Priorities
  • Products
  • Versions

The Management screen

4.7.4.1. Builds

The entity build describes the operating system version (build) used for Test Cases. This is particularly important to help ensure Test Cases are repeatable.

4.7.4.1.1. Procedure: Adding a build

To add a build:

  1. From the ADMIN menu, click Management.

  2. Click Builds.

  3. Click Add build.

  4. In the Add build screen, perform the following actions:

    • Enter Name.
    • Select Product.
    • Enter build Description.

    The Add build screen

  5. Click Save.

4.7.4.1.2. Editing a build

The name, product, and is active fields can be edited.

4.7.4.1.2.1. Procedure: Editing a test build

To edit a test build:

  1. From the ADMIN menu, click Management.
  2. Click Test Build.
  3. Click the ID of the Test Build to be edited.
  4. In the Change Test Build screen edit the following:
    • Name
    • Product
    • Description
    • Is active
  5. Click Save.

4.7.4.2. Classifications

A classification is a title used to group products of a similar nature. For example, Red Hat, Fedora, Internal Infrastructure.

4.7.4.2.1. Procedure: Adding a classification

To add a classification:

  1. From the ADMIN menu, click Management.

    The Admin menu 2

  2. Click Classifications.

  3. Click Add classification.

  4. In the Add classification screen, perform the following actions:

    • Enter the Name.
    • Enter a Description.
    • Enter the Sortkey.

    The Add classification screen

  5. Click Save.

4.7.4.2.2. Editing a classification

The name and description fields can be edited.

  1. From the ADMIN menu, click Management.
  2. Click Classification.
  3. Click the ID of the classification to edit.
  4. In the Change classification screen edit the following:
    • Name
    • Description
    • Sortkey
  5. Click Save.

4.7.4.3. Components

A product is broken down into components. For example, two components of RHEL 5 are glibc and gdm.

4.7.4.3.1. Procedure: Adding a component

To add a component:

  1. From the ADMIN menu, click Management.

  2. Click Components.

  3. Click Add component.

  4. In the Add component screen, perform the following actions:

    • Enter the Name.
    • Select the Product.
    • Select the Initial owner.
    • Select the Initial QA contact.
    • Enter the component Description.

    The Add component screen

  5. Click Save.

Note

Creating entries To create the fields Product, Initial Owner, or Initial QA Contact, click the green plus icon.

4.7.4.3.2. Editing a component

The fields name, product, initial owner, QA contact, and description can be edited.

4.7.4.3.2.1. Procedure: Editing a component

To edit a component:

  1. From the ADMIN menu, click Management.
  2. Click Component.
  3. Click the ID of the component to be edited.
  4. In the Change component screen edit the following:
    • Name
    • Product
    • Initial Owner
    • Initial QA contact
    • Description
  5. Click Save.

4.7.4.4. Priorities

Test Cases can be assigned a priority.

4.7.4.4.1. Adding a priority

The priority field is alphanumeric.

4.7.4.4.1.1. Procedure: Adding a priority

To add a priority:

  1. From the ADMIN menu, click Management.

  2. Click Priorities.

  3. Click Add priority.

  4. In the Add priority screen, perform the following actions:

    • Enter the Value.
    • Enter the Sortkey.
    • Click Is active.

    The Add priority screen

  5. Click Save.

4.7.4.4.2. Editing a priority

All three attributes of a Priority can be edited.

4.7.4.4.2.1. Procedure: Editing a priority

To edit a priority:

  1. From the ADMIN menu, click Management.
  2. Click Priorities.
  3. From the Id column, click the priority to edit.
  4. In the Change priorities screen, edit the following:
    • Value
    • Sortkey
    • Is active
  5. Click Save.

4.7.4.5. Products

All testing is based around the products made by Red Hat.

4.7.4.5.1. Procedure: Adding a product

To add a product:

  1. From the ADMIN menu, click Management.

  2. Click Products.

  3. Click Add product.

  4. In the Add product screen, perform the following actions:

    • Enter the Name.
    • Select the Classification.
    • Enter the product Description.
    • Click Disallow New.
    • Select the Votes Per User.
    • Enter the Max Votes Per Bug.
    • Click Votes To Confirm.

    The Add product screen

  5. Click Save.

4.7.4.5.2. Editing a product

The fields name, classification, description, disallow new and votes to confirm can be edited.

4.7.4.5.2.1. Procedure: Editing a product

To edit a product:

  1. From the ADMIN menu, click Management.
  2. Click Products.
  3. Click the ID of the product to be edited.
  4. In the Change product screen, edit the following:
    • Name
    • Classification
    • Description
    • Disallow New
    • Votes To Confirm
  5. Click Save.

4.7.4.6. Versions

Each product in KiwiTestPad needs a version. Many products will have multiple versions. For example, Firefox 3.0.14, 3.5.3.

4.7.4.6.1. Procedure: Adding a version

To add a version:

  1. From the ADMIN menu, click Management.

  2. Click Versions.

  3. Click Add version.

  4. In the Add version screen, perform the following actions:

    • Enter Value.
    • Select Product.

    The Add version screen

  5. Click Save.

4.7.4.6.2. Editing a version

The fields value, and product can be edited.

4.7.4.6.2.1. Procedure: Editing a version

To edit a version:

  1. From the ADMIN menu, click Management.
  2. Click Versions.
  3. Click the ID of the Version to be edited.
  4. In the Change version screen, edit the following:
    • Value
    • Product
  5. Click Save.

4.7.5. Managing Test Plans

This section covers the administration of meta data relating to Test Plans.

The Test Plan management screen

4.7.5.1. Test Plan types

A Test Plan type is used to describe the test being performed. For example, acceptance or smoke.

4.7.5.1.1. Adding a Test Plan type

A new type needs a name, and description.

4.7.5.1.1.1. Procedure: Adding a Test Plan type

To add a Test Plan type:

  1. From the ADMIN menu, click Test Plans.

  2. Click Test Plan Categories.

  3. Click Add Test Plan Types.

  4. In the Add test plan type screen, perform the following actions:

    • Enter the Name.
    • Enter the type Description.

    The Add test plan type screen

  5. Click Save.

4.7.5.2. Test plans

This screen provides a list of all the test plans in KiwiTestPad. The Add test plan link can be used to create a test plan. For more information, see Creating a Test Plan.

4.7.6. Managing Test Cases

This section covers the administration of meta data relating to Test Cases.

The Test Case management screen

4.7.6.1. Test Case Bug Systems

The bug system for test cases is Red Hat Bugzilla. To view the details click the Test case bug systems.

4.7.6.2. Test Case categories

A category is used to describe the type of test being performed. For example, regression or bug verification.

4.7.6.2.1. Adding a Test Case category

A new category needs a name, product and description.

4.7.6.2.1.1. Procedure: Adding a category

To add a category:

  1. From the ADMIN menu, click Test Cases.

  2. Click Test case categories.

  3. Click Add Test Case Category.

  4. In the Add test case category screen, perform the following actions:

    • Enter the Name.
    • Select the Product.
    • Enter the category Description.

    The Add test case category screen

  5. Click Save.

4.7.6.3. Test cases

This screen provides a list of all the test cases in KiwiTestPad. The Add test case link can be used to create a test case. For more information, see Creating a Test Case.