summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use/UnitTests.rst
diff options
context:
space:
mode:
authorSteven Pisarski <s.pisarski@cablelabs.com>2017-02-17 16:57:08 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-02-17 16:57:08 +0000
commit7aaba119cdca72819108ea1e94a6a7fc0224e079 (patch)
treefbad6efcf69745ac524de9a08c3296743b988dcc /docs/how-to-use/UnitTests.rst
parent906f2bd9f82de261b2871e7877b0694da4331091 (diff)
parentc5301a7a2e890fed97ffe04b40ccbe331e7f4a0b (diff)
Merge "Converted existing markdown documentation to RST format. Removed MD versions. Moved examples directory up one under repo root Moved RST files under docs/how-to-use"
Diffstat (limited to 'docs/how-to-use/UnitTests.rst')
-rw-r--r--docs/how-to-use/UnitTests.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst
new file mode 100644
index 0000000..efd6426
--- /dev/null
+++ b/docs/how-to-use/UnitTests.rst
@@ -0,0 +1,91 @@
+SNAPS Unit Testing
+==================
+
+| Tests designated as Unit tests extend the unittest.TestCase class and
+ can be exercised without any external resources
+| other than the filesystem. Most of these tests simply ensure that the
+ configuration settings classes check their
+| constructor arguments properly.
+
+The Test Classes
+================
+
+FileUtilsTests
+--------------
+
+- testFileIsDirectory - ensures that the expected path is a directory
+- testFileNotExist - ensures that a file that does not exist returns
+ False
+- testFileExists - ensures that a file that does exist returns True
+- testDownloadBadUrl - ensures that an Exception is thrown when
+ attempting to download a file with a bad URL
+- testCirrosImageDownload - ensures that the Cirros image can be
+ downloaded
+- testReadOSEnvFile - ensures that an OpenStack RC file can be properly
+ parsed
+
+SecurityGroupRuleSettingsUnitTests
+----------------------------------
+
+Ensures that all required members are included when constructing a
+SecurityGroupRuleSettings object
+
+SecurityGroupSettingsUnitTests
+------------------------------
+
+Ensures that all required members are included when constructing a
+SecuirtyGroupSettings object
+
+ImageSettingsUnitTests
+----------------------
+
+Ensures that all required members are included when constructing a
+ImageSettings object
+
+KeypairSettingsUnitTests
+------------------------
+
+Ensures that all required members are included when constructing a
+KeypairSettings object
+
+UserSettingsUnitTests
+---------------------
+
+Ensures that all required members are included when constructing a
+UserSettings object
+
+ProjectSettingsUnitTests
+------------------------
+
+Ensures that all required members are included when constructing a
+ProjectSettings object
+
+NetworkSettingsUnitTests
+------------------------
+
+Ensures that all required members are included when constructing a
+NetworkSettings object
+
+SubnetSettingsUnitTests
+-----------------------
+
+Ensures that all required members are included when constructing a
+SubnetSettings object
+
+PortSettingsUnitTests
+---------------------
+
+Ensures that all required members are included when constructing a
+PortSettings object
+
+FloatingIpSettingsUnitTests
+---------------------------
+
+Ensures that all required members are included when constructing a
+FloatingIpSettings object
+
+VmInstanceSettingsUnitTests
+---------------------------
+
+Ensures that all required members are included when constructing a
+VmInstanceSettings object