docs/how-to-use/UnitTests.rst

   1 SNAPS Unit Testing
   2 ==================
   3
   4 | Tests designated as Unit tests extend the unittest.TestCase class and
   5   can be exercised without any external resources
   6 | other than the filesystem. Most of these tests simply ensure that the
   7   configuration settings classes check their
   8 | constructor arguments properly.
   9
  10 The Test Classes
  11 ================
  12
  13 FileUtilsTests
  14 --------------
  15
  16 -  testFileIsDirectory - ensures that the expected path is a directory
  17 -  testFileNotExist - ensures that a file that does not exist returns
  18    False
  19 -  testFileExists - ensures that a file that does exist returns True
  20 -  testDownloadBadUrl - ensures that an Exception is thrown when
  21    attempting to download a file with a bad URL
  22 -  testCirrosImageDownload - ensures that the Cirros image can be
  23    downloaded
  24 -  testReadOSEnvFile - ensures that an OpenStack RC file can be properly
  25    parsed
  26
  27 ProxySettingsUnitTests
  28 ----------------------
  29
  30 Ensures that all required members are included when constructing a
  31 ProxySettings object
  32
  33 OSCredsUnitTests
  34 ----------------
  35
  36 Ensures that all required members are included when constructing a
  37 OSCreds object
  38
  39 SecurityGroupRuleSettingsUnitTests
  40 ----------------------------------
  41
  42 Ensures that all required members are included when constructing a
  43 SecurityGroupRuleSettings object
  44
  45 SecurityGroupRuleDomainObjectTests
  46 ----------------------------------
  47
  48 Ensures that all required members are included when constructing a
  49 SecurityGroupRule domain object
  50
  51 SecurityGroupSettingsUnitTests
  52 ------------------------------
  53
  54 Ensures that all required members are included when constructing a
  55 SecuirtyGroupSettings object
  56
  57 SecurityGroupDomainObjectTests
  58 ------------------------------
  59
  60 Ensures that all required members are included when constructing a
  61 SecurityGroup domain object
  62
  63 ImageSettingsUnitTests
  64 ----------------------
  65
  66 Ensures that all required members are included when constructing a
  67 ImageSettings object
  68
  69 ImageDomainObjectTests
  70 ----------------------
  71
  72 Ensures that all required members are included when constructing a
  73 Image domain object
  74
  75 FlavorSettingsUnitTests
  76 -----------------------
  77
  78 Ensures that all required members are included when constructing a
  79 FlavorSettings object
  80
  81 FlavorDomainObjectTests
  82 -----------------------
  83
  84 Ensures that all required members are included when constructing a
  85 Flavor domain object
  86
  87 KeypairSettingsUnitTests
  88 ------------------------
  89
  90 Ensures that all required members are included when constructing a
  91 KeypairSettings object
  92
  93 KeypairDomainObjectTests
  94 ------------------------
  95
  96 Ensures that all required members are included when constructing a
  97 Keypair domain object
  98
  99 UserSettingsUnitTests
 100 ---------------------
 101
 102 Ensures that all required members are included when constructing a
 103 UserSettings object
 104
 105 UserDomainObjectTests
 106 ---------------------
 107
 108 Ensures that all required members are included when constructing a
 109 User domain object
 110
 111 ProjectSettingsUnitTests
 112 ------------------------
 113
 114 Ensures that all required members are included when constructing a
 115 ProjectSettings object
 116
 117 ProjectDomainObjectTests
 118 ------------------------
 119
 120 Ensures that all required members are included when constructing a
 121 Project domain object
 122
 123 RoleDomainObjectTests
 124 ---------------------
 125
 126 Ensures that all required members are included when constructing a
 127 Role domain object
 128
 129 NetworkSettingsUnitTests
 130 ------------------------
 131
 132 Ensures that all required members are included when constructing a
 133 NetworkSettings object
 134
 135 NetworkObjectTests
 136 ------------------
 137
 138 Ensures that all required members are included when constructing a
 139 Network domain object
 140
 141 SubnetSettingsUnitTests
 142 -----------------------
 143
 144 Ensures that all required members are included when constructing a
 145 SubnetSettings object
 146
 147 SubnetObjectTests
 148 -----------------
 149
 150 Ensures that all required members are included when constructing a
 151 Subnet domain object
 152
 153 PortSettingsUnitTests
 154 ---------------------
 155
 156 Ensures that all required members are included when constructing a
 157 PortSettings object
 158
 159 PortDomainObjectTests
 160 ---------------------
 161
 162 Ensures that all required members are included when constructing a
 163 Port domain object
 164
 165 RouterSettingsUnitTests
 166 -----------------------
 167
 168 Ensures that all required members are included when constructing a
 169 RouterSettings object
 170
 171 RouterDomainObjectTests
 172 -----------------------
 173
 174 Ensures that all required members are included when constructing a
 175 Router domain object
 176
 177 InterfaceRouterDomainObjectTests
 178 --------------------------------
 179
 180 Ensures that all required members are included when constructing a
 181 InterfaceRouter domain object
 182
 183 StackSettingsUnitTests
 184 ----------------------
 185
 186 Ensures that all required members are included when constructing a
 187 StackSettings object
 188
 189 StackDomainObjectTests
 190 ----------------------
 191
 192 Ensures that all required members are included when constructing a
 193 Stack domain object
 194
 195 FloatingIpSettingsUnitTests
 196 ---------------------------
 197
 198 Ensures that all required members are included when constructing a
 199 FloatingIpSettings object
 200
 201 FloatingIpDomainObjectTests
 202 ---------------------------
 203
 204 Ensures that all required members are included when constructing a
 205 FloatingIp domain object
 206
 207 VmInstanceSettingsUnitTests
 208 ---------------------------
 209
 210 Ensures that all required members are included when constructing a
 211 VmInstanceSettings object
 212
 213 VmInstDomainObjectTests
 214 -----------------------
 215
 216 Ensures that all required members are included when constructing a
 217 VmInst domain object