summaryrefslogtreecommitdiffstats
path: root/docs/UnitTests.md
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2017-02-15 09:13:54 -0700
committerspisarski <s.pisarski@cablelabs.com>2017-02-15 09:15:34 -0700
commit57777f3df521553a06cd01a3861b415d2905ceca (patch)
treef3b3be457baec7b5231309989aa3ffa9658cd25d /docs/UnitTests.md
parent73ef791a1cde68e0d8d69cddf63534fbb90f3e2d (diff)
Initial patch with all code from CableLabs repository.
Change-Id: I70a2778718c5e7f21fd14e4ad28c9269d3761cc7 Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs/UnitTests.md')
-rw-r--r--docs/UnitTests.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/UnitTests.md b/docs/UnitTests.md
new file mode 100644
index 0000000..59fc2d9
--- /dev/null
+++ b/docs/UnitTests.md
@@ -0,0 +1,48 @@
+# 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