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 DomainDomainObjectTests
 124 -----------------------
 125
 126 Ensures that all required members are included when constructing a
 127 Domain domain object
 128
 129 ComputeQuotasDomainObjectTests
 130 ------------------------------
 131
 132 Ensures that all required members are included when constructing a
 133 ComputeQuotas domain object
 134
 135 NetworkQuotasDomainObjectTests
 136 ------------------------------
 137
 138 Ensures that all required members are included when constructing a
 139 NetworkQuotas domain object
 140
 141 RoleDomainObjectTests
 142 ---------------------
 143
 144 Ensures that all required members are included when constructing a
 145 Role domain object
 146
 147 NetworkSettingsUnitTests
 148 ------------------------
 149
 150 Ensures that all required members are included when constructing a
 151 NetworkSettings object
 152
 153 NetworkObjectTests
 154 ------------------
 155
 156 Ensures that all required members are included when constructing a
 157 Network domain object
 158
 159 SubnetSettingsUnitTests
 160 -----------------------
 161
 162 Ensures that all required members are included when constructing a
 163 SubnetSettings object
 164
 165 SubnetObjectTests
 166 -----------------
 167
 168 Ensures that all required members are included when constructing a
 169 Subnet domain object
 170
 171 PortSettingsUnitTests
 172 ---------------------
 173
 174 Ensures that all required members are included when constructing a
 175 PortSettings object
 176
 177 PortDomainObjectTests
 178 ---------------------
 179
 180 Ensures that all required members are included when constructing a
 181 Port domain object
 182
 183 RouterSettingsUnitTests
 184 -----------------------
 185
 186 Ensures that all required members are included when constructing a
 187 RouterSettings object
 188
 189 RouterDomainObjectTests
 190 -----------------------
 191
 192 Ensures that all required members are included when constructing a
 193 Router domain object
 194
 195 InterfaceRouterDomainObjectTests
 196 --------------------------------
 197
 198 Ensures that all required members are included when constructing a
 199 InterfaceRouter domain object
 200
 201 StackSettingsUnitTests
 202 ----------------------
 203
 204 Ensures that all required members are included when constructing a
 205 StackSettings object
 206
 207 StackDomainObjectTests
 208 ----------------------
 209
 210 Ensures that all required members are included when constructing a
 211 Stack domain object (for Heat)
 212
 213 ResourceDomainObjectTests
 214 -------------------------
 215
 216 Ensures that all required members are included when constructing a
 217 Resource domain object (for Heat)
 218
 219 OutputDomainObjectTests
 220 -----------------------
 221
 222 Ensures that all required members are included when constructing a
 223 Output domain object (for Heat)
 224
 225 VolumeSettingsUnitTests
 226 -----------------------
 227
 228 Ensures that all required members are included when constructing a
 229 VolumeSettings object
 230
 231 VolumeDomainObjectTests
 232 -----------------------
 233
 234 Ensures that all required members are included when constructing a
 235 Volume domain object (for Cinder)
 236
 237 VolumeTypeSettingsUnitTests
 238 ---------------------------
 239
 240 Ensures that all required members are included when constructing a
 241 VolumeTypeSettings object
 242
 243 VolumeTypeDomainObjectTests
 244 ---------------------------
 245
 246 Ensures that all required members are included when constructing a
 247 VolumeType domain object (for Cinder)
 248
 249 VolumeTypeEncryptionObjectTests
 250 -------------------------------
 251
 252 Ensures that all required members are included when constructing a
 253 VolumeTypeEncryption domain object (for Cinder)
 254
 255 QoSSettingsUnitTests
 256 --------------------
 257
 258 Ensures that all required members are included when constructing a
 259 QoSSettings object
 260
 261 QoSSpecDomainObjectTests
 262 ------------------------
 263
 264 Ensures that all required members are included when constructing a
 265 QoSSpec domain object (for Cinder)
 266
 267 VolumeDomainObjectTests
 268 -----------------------
 269
 270 Ensures that all required members are included when constructing a
 271 Volume domain object (for Cinder)
 272
 273 FloatingIpSettingsUnitTests
 274 ---------------------------
 275
 276 Ensures that all required members are included when constructing a
 277 FloatingIpSettings object
 278
 279 FloatingIpDomainObjectTests
 280 ---------------------------
 281
 282 Ensures that all required members are included when constructing a
 283 FloatingIp domain object
 284
 285 VmInstanceSettingsUnitTests
 286 ---------------------------
 287
 288 Ensures that all required members are included when constructing a
 289 VmInstanceSettings object
 290
 291 VmInstDomainObjectTests
 292 -----------------------
 293
 294 Ensures that all required members are included when constructing a
 295 VmInst domain object
 296
 297 SettingsUtilsVolumeTests
 298 ------------------------
 299
 300 Ensures that the settings_utils.py#create_volume_settings() function properly
 301 maps a snaps.domain.Volume object correctly to a
 302 snaps.openstack.create_volume.VolumeSettings object as well as a
 303 snaps.domain.VolumeType object to a
 304 snaps.openstack.create_volume.VolumeSettings object