Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

Latest commit

 

History

History
160 lines (124 loc) · 6.95 KB

Readme.md

File metadata and controls

160 lines (124 loc) · 6.95 KB
Raw

#Running tests for military-tools-geoprocessing-toolbox

##Sections

##Introduction The unittests in this section of the repository are designed to test the geoprocessing tools contained within to make sure they are running consistently under different conditions. Automated testing, unittests are one type, help reduce the amount of time necessary to find defects or confirm their success. An automated test can run all of the tools in a significantly shorter amount of time than several people testing the tools manually. This should not be taken as an opportunity to skip other types of testing (ad-hoc, defect verification, template testing, system testing, etc.).

##Requirements ###For ArcGIS Pro Tools for ArcGIS Pro are in the Military_Tools_pro.tbx toolbox and have the following requirements:

  • ArcGIS Pro 1.1 to ArcGIS Pro 1.3
    • Python 3.4.1 for ArcGIS Pro
  • ArcGIs Pro 1.3.1+

###For ArcGIS Desktop Tools for ArcMap are in the Military_Tools_arcmap.tbx toolbox and have the following requirements:

  • ArcGIS for Desktop 10.3.1+
  • Python 2.7+

##Running the tests The goal is to run the test suites for all of the tools against different versions of operating systems and versions of Python/ArcGIS.

  1. Check your ArcGIS versions. You need to have at least ONE of two required versions listed above.
  2. Modify the correct .bat.
    1. ArcMapTestKickStart.bat to run tests for ArcMap, or
    2. ArcGISProTestKickStart.bat for ArcGIS Pro.
  3. Open a command prompt in .\military-tools-geoprocessing-toolbox\utils\test.
  4. Run the appropriate .bat
    1. ArcMapTestKickStart.bat to run tests for ArcMap, or
    2. ArcGISProTestKickStart.bat for ArcGIS Pro.
  5. Check the dialog for results and check the log file created by the tests.

##Log files The output from running the tests are stored in the .\military-tools-geoprocessing-toolbox\utils\test\log folder. The files are named:

 MTGT_YYYY-Month-DD_HH-MM-SS_seqX.log

where:

  • YYYY - Four digit year
  • Month - American English name of month
  • DD - Two digit day of the month (01 - 31)
  • HH - Two digit hour of the day in 24-hour format (00 - 23)
  • MM - Two digit minute of the hour (00 - 59)
  • SS - Two digit second of the minute (00 - 59)
  • X - sequence number, if for reason two log files are created in the same exact second. Unlikely, but just in case.

For example:

MTGT_2016-November-05_08-31-22_seq0.log

This log file was created November 5th, 2016 at 8:31:22 AM and was the first log file created at that time.

##Reporting errors as Issues Any errors or problems need to be reported. If they go unmentioned, then they go unfixed. All issues should be logged in the military-tools-geoprocessing-repository Issues.

  1. First you should check the existing Issues to see if there is one already logged for the issue you found. If you find one that is the same or similar, please add a comment to it with the information in step 4 below.
  2. Check the information you've collected. Make sure you've got a clear idea of what is happening, what you expected, and how the tool is expected to work.
  3. Start a new issue and include the following information.
    1. Add a good description of the problem. It should answer:
      1. What tool were you using, what inputs did you use (be specific)?
      2. What happened?
      3. What did you expect to happen?
    2. Numbered steps to reproduce the problem
    3. Add a copy of the full error message
    4. Include a copy of the log file
  4. Assign to the repository owner.

##What is being tested So what is being tested for the tools in this toolbox? Below is a list of the type of questions that the tool tests are answering.

All tools

  • Does the tool run?
  • Is the output created (does it actually exist where it says it should)?
  • Do all of the input parameters work?
  • Do the tools work with different output spatial references?

Conversion

Convert Coordinates

  • Are the correct fields in the output (GARS, DDLat, DDLon, DDMLat, DDMLon, UTM, MGRS, USNG, GEOREF)?
  • Are the converted values correct?
  • Does the tool accept different input notations formats?

Table To Point

  • Are the correct number of points created?
  • Does the output contain the correct fields (DDLat and DDLon)?

Table To 2-Point Line

  • Are the correct number of lines created given the number of input fields?

Table To Ellipse

  • Are the correct number of lines created (The ellipses are created a line feature type)?
  • Are the ellipses oriented correctly if the angle field is used?

Table To Line Of Bearing

  • Are the correct number of lines created?
  • Are the end points correct for the input angle and distance?

Table To Polygon

  • Are the correct number of polygons created?
  • Are the polygons grouped correctly if the group field is used?
  • Are the polygon vertices sorted correctly if the sort field is used?

Table To Polyline

  • Are the correct number of lines created?
  • Are the lines grouped correctly if the group field is used?
  • Are the line vertices storted correctly if the sort field is used?

Distance and Direction

** Range Rings (from Interval)**

  • Correct number of rings were created?
  • Correct number of radials were created?

** Range Rings from Minimum Maximum**

  • Correct number of rings were created?
  • Correct number of radials were created?

** Range Rings from Minimum Maximum Table**

  • Correct number of rings were created?
  • Correct number of radials were created?

Find Local Peaks

  • Is the expected number of output features produced? (there might be several output points produced especially near water)
  • Is the elevation field (name?) added to the output?

Highest Points

  • is the expected number of output features produced? (there might be more than one point with the same highest elevation)
  • Is the elevation field (name?) added to the output?

Lowest Points

  • Is the correct number of points produced?
  • Is the 'elevation' value in the correct field?
  • Is the 'elevation' value correct?

Visibility

Add Observer Fields

  • Are the correct fields added?
  • Are the correct default field values added to the fields for each row?

Linear Line of Sight

  • Is the correct number of visible line features produced?
  • Is the correct number of invisible line features produced?
  • Are the correct fields added to the output features?

Radial Line of Sight

  • Does the result include the correct number of output area types (visible/not-visible)?
  • Do the result include the correct number of features (this is based on the result that exist in the results.gdb in test data)?