Add configurable hostname pattern to filter hosts

Currently when aggregating potential target hosts via
get_host_other_than, it's hostname filtering only addresses the suffix
'-ironic'. In the event that pattern is located within the hostname e.g.
nova-cell1-compute-ironic-compute-0, then it will still be used as a
target candidate. Update tempest to allow for a configurable hostname
pattern to filter on when searching for candidates.

Also updated additional testcases that are still using the suffix only
check when removing guests with ironic in the name.

Change-Id: If5bab817e04412512186be2195cd2437bd310980
diff --git a/tempest/config.py b/tempest/config.py
index 0fcc71c..9d7526a 100644
--- a/tempest/config.py
+++ b/tempest/config.py
@@ -418,7 +418,11 @@
                help="Specify destination host for live-migration and cold"
                     " migration. If option is not set tests will use host"
                     " automatically."),
-
+    cfg.StrOpt('target_hosts_to_avoid',
+               default='-ironic',
+               help="When aggregating available hypervisors for testing,"
+               " avoid migrating to and booting any test VM on hosts with"
+               " a name that matches the provided pattern"),
 ]
 
 placement_group = cfg.OptGroup(name='placement',