Skip to content

Commit

Permalink
Additions to Manual Testing Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
brittainhard committed Nov 4, 2015
1 parent b0a4751 commit 848f68b
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 53 deletions.
Binary file modified docs/source/_static/img/testing_guide/edit_index_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/img/testing_guide/index_creation_success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 31 additions & 53 deletions docs/source/manual_testing_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,21 @@ Project Creation

a. Click the new project button.
b. Provide a name and a description for the project on the next page, and press submit.
c. Verify that you see a green banner at the top of the screen confirming that you have successfully created the project.

.. image:: _static/img/testing_guide/project_success_message.png

d. In the top right of the screen, verify that the projects dropdown is working, and that it list the name of project you just created.
e. On the right side of the screen, click the "list" icons to test that the dropdowns are working.
f. Verify that both dropdowns are empty, and that no indices or crawls have been created.
c. Veryify that your new project shows up on the project page list.
d. Click on the new project and go to the project page. Verify that there are no crawls, models, or datasets yet.

Project Settings
================
1. Click the "gears" icon next to the name of the project on the project overview page.

.. image:: _static/img/testing_guide/settings.png
1. Click the "pencil" icon next to the name of the project on the project overview page.

a. Supply a different name and description for the project, and hit "submit".
b. Verify that the project was edited successfully by checking the success message at the top of the page.

.. image:: _static/img/testing_guide/project_edit_success.png
2. Go back to the settings page.

1. Go back to the settings page.

a. Click on the "trashcan" icon. Verify that there is a popup asking you whether you want to delete the project.
b. Click no, and verify that you get a second popup which verifies that you cancelled.
c. Click on the trash icon and click yes.
d. Verify that you are taken to the landing page, and that there are no projects listed on the landing page.
a. Click on the "trashcan" icon. Verify that there is a popup asking you whether you want to delete the project.
b. Click on the trash icon and click yes.
c. Verify that you are taken to the landing page, and that there are no projects listed on the landing page.

***************
Testing Indices
Expand All @@ -56,11 +46,6 @@ Index Creation

.. image:: _static/img/testing_guide/index_creation_success.png

6. In your browser, open a new tab or window and goto http://localhost:9200/. This is the location of the elasticsearch instance.

a. Navigate to your newly created index using the following URL structure: localhost:9200/<index_name>/_search?pretty.
b. Verify that the newly created index reflects the number of documents in your zipfile and the content of those documents.

Index Settings
==============
1. Click on the link to the index on the project overview page. This will take you to the index settings page.
Expand All @@ -75,6 +60,26 @@ Index Settings

a. Confirm that the index was deleted successfully by looking at the list of indices on the project overview page.

*************
Testing Seeds
*************

At the navbar, click on the "Seeds" tab.

1. Create a Seeds List

a. Create a seeds list by providing a file.
b. Create another by pasting URLs into the textbox.
c. Paste in invalid URL into the textbox, and verify that it is highlighted red.

2. Edit a seeds list

a. Click on the icon for the seeds list to access the edit seeds page.
b. Remove some URLs and click "Reset" to return to the original seeds list.
c. Make one of the URLs invalid, and press "Save"
d. Verify that the invalid URL is highlighted with red.
e. Fix or remove the URL and click "Save"

**************
Testing Crawls
**************
Expand All @@ -90,13 +95,10 @@ Included with the repository is a test seeds file. You can use this file to test

.. image:: _static/img/testing_guide/crawler_nutch.png

b. Add the seeds list from test_resources/test_crawl_data/cats.seeds , and hit "Submit"
b. Select one of the previously created seed lists and create the crawl.

3. Verify that the crawl has been added successfully.

.. image:: _static/img/testing_guide/crawl_added_success.png

4. You should now be on the crawl page.
3. Verify that the crawl has been added successfully to the crawls list table.
4. Go to the crawl page by following the link in the crawls list table.

a. Verify that the crawl status and available buttons are the same as in this image.

Expand All @@ -105,39 +107,15 @@ Included with the repository is a test seeds file. You can use this file to test
b. The following buttons should be available: "Start Crawl", "Get Seeds List". All other buttons should be greyed-out.
c. The crawl status should be set to NOT STARTED with 0 rounds left to crawl.

5. Create another nutch crawl, but this time copy the contents of the cats.seeds file into the textbox. Submit the crawl.

a. On the crawl page, click the "Get Seeds List" button.
b. Verify that the contents of the downloaded file match the contents of cats.seeds.

6. Verify that the crawl completes successfully.
5. Start a crawl and verify that the crawl completes successfully.

a. When you start the crawl, there should be two rounds left.
b. At the end of the first round, summary statistics should list total pages crawled as between 6 and 9.
c. After the first round is done, the status should show "SUCCESS" before going onto the next round.
d. On the start of the next round, the crawl status should change to "STARTED"
e. At the end of the second round, the rounds left should be zero.
f. The pages crawled should be between 300 and 400.
g. The crawl control dashboard should resemble this:

.. image:: _static/img/testing_guide/crawl_buttons_success.png

7. Verify the crawl index

a. Refer to step 6 of :ref:`index-creation` on how to access the index from the browser.
b. Type in the name of the crawl index to see the crawl data. Verify that there are between 200 and 300 "hits", or documents.

8. Verify that kibana is functioning.

a. Click on the Kibana tab.
b. Enter the following information on the "Settings" page.

.. image:: _static/img/testing_guide/add_index_kibana.png

c. Head to the "Discover" page.
d. Verify that you get the following output:

.. image:: _static/img/testing_guide/kibana_data.png

Test Crawl Settings
====================
Expand Down

0 comments on commit 848f68b

Please sign in to comment.