Merge pull request #313 from cisco/release_1.3.0

Convert test_vxlan_vtep to use new syntax

Author: chrisvanheuveln

lib/puppet/provider/cisco_vxlan_vtep/cisco.rb

@@ -148,7 +148,6 @@ def puts_config
     VXLAN_VTEP_ALL_PROPS.each do |prop|
       current.concat(sprintf("\n%30s: %s", prop, @vtep_interface.send(prop)))
     end
-    # debug current
-    puts current
+    debug current
   end # puts_config
 end

tests/beaker_tests/cisco_vxlan_vtep/test_vxlan_vtep.rb

@@ -13,258 +13,88 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 ###############################################################################
-# TestCase Name:
-# -------------
-# test-cisco_vxlan_vtep.rb
 #
-# TestCase Prerequisites:
-# -----------------------
-# This is a Puppet cisco_vxlan_vtep resource testcase for Puppet Agent on
-# Nexus devices.
-# The test case assumes the following prerequisites are already satisfied:
-#   - Host configuration file contains agent and master information.
-#   - SSH is enabled on the N9K Agent.
-#   - Puppet master/server is started.
-#   - Puppet agent certificate has been signed on the Puppet master/server.
-#
-# TestCase:
-# ---------
-# This cisco_vxlan_vtep resource test verifies default and non-default values
-# for all properties.
-#
-# The following exit_codes are validated for Puppet, Vegas shell and
-# Bash shell commands.
-#
-# Vegas and Bash Shell Commands:
-# 0   - successful command execution
-# > 0 - failed command execution.
-#
-# Puppet Commands:
-# 0 - no changes have occurred
-# 1 - errors have occurred,
-# 2 - changes have occurred
-# 4 - failures have occurred and
-# 6 - changes and failures have occurred.
-#
-# NOTE: 0 is the default exit_code checked in Beaker::DSL::Helpers::on() method.
-#
-# The test cases use RegExp pattern matching on stdout or output IO
-# instance attributes to verify resource properties.
+# See README-develop-beaker-scripts.md (Section: Test Script Variable Reference)
+# for information regarding:
+#  - test script general prequisites
+#  - command return codes
+#  - A description of the 'tests' hash and its usage
 #
 ###############################################################################
-
 require File.expand_path('../../lib/utilitylib.rb', __FILE__)
 
-# -----------------------------
-# Common settings and variables
-# -----------------------------
-testheader = 'Resource cisco_vxlan_vtep'
-
-# The 'tests' hash is used to define all of the test data values and expected
-# results. It is also used to pass optional flags to the test methods when
-# necessary.
-
-# 'tests' hash
-# Top-level keys set by caller:
-# tests[:master] - the master object
-# tests[:agent] - the agent object
-#
+# Test hash top-level keys
 tests = {
-  master:        master,
-  agent:         agent,
-  platform:      'n(5|6|7|8|9)k',
-  resource_name: 'cisco_vxlan_vtep',
-}
-
-# tests[id] keys set by caller and used by test_harness_common:
-#
-# tests[id] keys set by caller:
-# tests[id][:desc] - a string to use with logs & debugs
-# tests[id][:manifest] - the complete manifest, as used by test_harness_common
-# tests[id][:resource] - a hash of expected states, used by test_resource
-# tests[id][:resource_cmd] - 'puppet resource' command to use with test_resource
-# tests[id][:ensure] - (Optional) set to :present or :absent before calling
-# tests[id][:code] - (Optional) override the default exit code in some tests.
-#
-# These keys are local use only and not used by test_harness_common:
-#
-# tests[id][:manifest_props] - This is essentially a master list of properties
-#   that permits re-use of the properties for both :present and :absent testing
-#   without destroying the list
-# tests[id][:resource_props] - This is essentially a master hash of properties
-#   that permits re-use of the properties for both :present and :absent testing
-#   without destroying the hash
-# tests[id][:title_pattern] - (Optional) defines the manifest title.
-#   Can be used with :af for mixed title/af testing. If mixing, :af values will
-#   be merged with title values and override any duplicates. If omitted,
-#   :title_pattern will be set to 'id'.
-# tests[id][:af] - (Optional) defines the address-family values.
-#   Must use :title_pattern if :af is not specified. Useful for testing mixed
-#   title/af manifests
-#
-tests['default_properties'] = {
-  title_pattern:  'nve1',
-  manifest_props: "
-    description                     => 'default',
-    host_reachability               => 'default',
-    shutdown                        => 'default',
-    source_interface                => 'default',
-  ",
-  resource_props: {
-    'host_reachability' => 'flood',
-    'shutdown'          => 'true',
-  },
+  agent:            agent,
+  master:           master,
+  operating_system: 'nexus',
+  platform:         'n(5|6|7|8|9)k',
+  resource_name:    'cisco_vxlan_vtep',
 }
 
-tests['non_default_properties'] = {
+# Test hash test cases
+tests[:default] = {
   title_pattern:  'nve1',
-  manifest_props: "
-    description                     => 'Configured by Puppet',
-    host_reachability               => 'evpn',
-    shutdown                        => 'false',
-    source_interface                => 'loopback55',
-  ",
-  resource_props: {
-    'description'       => 'Configured by Puppet',
-    'host_reachability' => 'evpn',
-    'shutdown'          => 'false',
-    'source_interface'  => 'loopback55',
+  preclean:       'cisco_vxlan_vtep',
+  manifest_props: {
+    description:                     'default',
+    host_reachability:               'default',
+    shutdown:                        'default',
+    source_interface:                'default',
+    source_interface_hold_down_time: 'default',
   },
-}
-
-# Source Interface Hold-down Time
-if platform[/n(8|9)k/]
-  tests['default_properties'][:manifest_props][:source_interface_hold_down_time] = 'default'
-  tests['non_default_properties'][:manifest_props][:source_interface_hold_down_time] = '100'
-  tests['non_default_properties'][:resource_props][:source_interface_hold_down_time] = '100'
-end
-
-tests['change_parameters'] = {
-  title_pattern:  'nve1',
-  manifest_props: "
-    host_reachability               => 'flood',
-    shutdown                        => 'true',
-    source_interface                => 'loopback1',
-  ",
-  resource_props: {
-    'description'       => 'Configured by Puppet',
+  resource:       {
     'host_reachability' => 'flood',
     'shutdown'          => 'true',
-    'source_interface'  => 'loopback1',
   },
 }
 
-tests['change_source_int_when_shutdown'] = {
+tests[:non_default] = {
   title_pattern:  'nve1',
-  manifest_props: "
-    source_interface   => 'loopback88',
-  ",
-  resource_props: {
-    'description'       => 'Configured by Puppet',
-    'host_reachability' => 'flood',
-    'shutdown'          => 'true',
-    'source_interface'  => 'loopback88',
+  manifest_props: {
+    description:                     'Puppet test',
+    host_reachability:               'evpn',
+    shutdown:                        'false',
+    source_interface:                'loopback55',
+    source_interface_hold_down_time: '100',
   },
 }
 
-#################################################################
-# HELPER FUNCTIONS
-#################################################################
-
-# Full command string for puppet resource command
-def puppet_resource_cmd
-  PUPPET_BINPATH + 'resource cisco_vxlan_vtep'
+def unsupported_properties(*)
+  unprops = []
+  unprops << :source_interface_hold_down_time unless platform[/n(8|9)k/]
+  unprops
 end
 
-def build_manifest_cisco_vxlan_vtep(tests, id)
-  if tests[id][:ensure] == :absent
-    state = 'ensure => absent,'
-    tests[id][:resource] = {}
-  else
-    state = 'ensure => present,'
-    manifest = tests[id][:manifest_props]
-    tests[id][:resource] = tests[id][:resource_props]
-  end
-
-  tests[id][:title_pattern] = id if tests[id][:title_pattern].nil?
-  logger.debug("build_manifest_cisco_vxlan_vtep :: title_pattern:\n" +
-               tests[id][:title_pattern])
-  tests[id][:manifest] = "cat <<EOF >#{PUPPETMASTER_MANIFESTPATH}
-  node 'default' {
-    cisco_vxlan_vtep { '#{tests[id][:title_pattern]}':
-      #{state}
-      #{manifest}
-    }
-  }
-EOF"
-end
-
-def test_harness_cisco_vxlan_vtep(tests, id)
-  return unless platform_supports_test(tests, id)
-
-  tests[id][:ensure] = :present if tests[id][:ensure].nil?
-  tests[id][:resource_cmd] = puppet_resource_cmd
-  tests[id][:desc] += " [ensure => #{tests[id][:ensure]}]"
-
-  # Build the manifest for this test
-  build_manifest_cisco_vxlan_vtep(tests, id)
-
-  test_manifest(tests, id)
-  test_resource(tests, id)
-  test_idempotence(tests, id)
+# Overridden to properly handle dependencies for this test file.
+def test_harness_dependencies(*)
+  return unless platform[/n(5|6)k/]
+  skip_if_nv_overlay_rejected(agent)
 
-  tests[id][:ensure] = nil
+  # Vxlan has a hard requirement to disable feature fabricpath on n5/6k
+  cmd = 'no feature-set fabricpath'
+  command_config(agent, cmd, cmd)
 end
 
 #################################################################
 # TEST CASE EXECUTION
 #################################################################
-test_name "TestCase :: #{testheader}" do
+test_name "TestCase :: #{tests[:resource_name]}" do
   skip_unless_supported(tests)
 
-  # -------------------------------------------------------------------
-  logger.info("\n#{'-' * 60}\nSection 1. Default Property Testing")
-  resource_absent_cleanup(agent, 'cisco_vxlan_vtep',
-                          'Setup switch for cisco_vxlan_vtep provider test')
-
   # -----------------------------------
-  id = 'default_properties'
-  tests[id][:desc] = '1.1 Default Properties'
-  test_harness_cisco_vxlan_vtep(tests, id)
+  logger.info("\n#{'-' * 60}\nSection 1. Default Property Testing")
+  id = :default
+  test_harness_run(tests, id)
 
-  tests[id][:desc] = '1.2 Default Properties'
   tests[id][:ensure] = :absent
-  test_harness_cisco_vxlan_vtep(tests, id)
+  tests[id].delete(:preclean)
+  test_harness_run(tests, id)
 
-  # -------------------------------------------------------------------
+  # -----------------------------------
   logger.info("\n#{'-' * 60}\nSection 2. Non Default Property Testing")
+  test_harness_run(tests, :non_default)
 
-  id = 'non_default_properties'
-  tests[id][:desc] = '2.1 Non-Default Properties'
-  test_harness_cisco_vxlan_vtep(tests, id)
-
-  tests[id][:desc] = '2.2 Non-Default Properties'
-  tests[id][:ensure] = :absent
-  test_harness_cisco_vxlan_vtep(tests, id)
-  # -------------------------------------------------------------------
-
-  # -------------------------------------------------------------------
-  logger.info("\n#{'-' * 60}\nSection 3. Property Changes")
-
-  id = 'non_default_properties'
-  tests[id][:desc] = '3.1 Setup'
-  test_harness_cisco_vxlan_vtep(tests, id)
-
-  id = 'change_parameters'
-  tests[id][:desc] = '3.1 Change host_reach, shutdown state, source int'
-  test_harness_cisco_vxlan_vtep(tests, id)
-
-  id = 'change_source_int_when_shutdown'
-  tests[id][:desc] = '3.1 Change source_interface, shutdown state: true'
-  test_harness_cisco_vxlan_vtep(tests, id)
-
-  resource_absent_cleanup(agent, 'cisco_vxlan_vtep',
-                          'Setup switch for cisco_vxlan_vtep provider test')
+  resource_absent_cleanup(agent, 'cisco_vxlan_vtep')
 end
-
-logger.info('TestCase :: # {testheader} :: End')
+logger.info("TestCase :: #{tests[:resource_name]} :: End")

tests/beaker_tests/lib/utilitylib.rb

@@ -810,6 +810,18 @@ def prereq_skip(testheader, testcase, message)
   raise_skip_exception(testheader, testcase)
 end
 
+# Some specific platform models do not support nv_overlay
+def skip_if_nv_overlay_rejected(agent)
+  logger.info('Check for nv overlay support')
+  cmd = get_vshell_cmd('config t ; feature nv overlay')
+  on(agent, cmd, pty: true)
+  # Failure message taken from 6001
+  msg = 'NVE Feature NOT supported on this Platform'
+  banner = '#' * msg.length
+  raise_skip_exception("\n#{banner}\n#{msg}\n#{banner}\n", self) if
+    stdout.match(msg)
+end
+
 # Return an interface name from the first MT-full compatible line module found
 def mt_full_interface
   # Search for F3 card on device, create an interface name if found