<?xml version='1.0' encoding='utf-8'?>
<SNMP>
  <Nodes defaultProtocolVersion="2c" defaultTimeout='1' defaultRetries='2' defaultPort='161'>
    <item name="node1" ip="192.94.214.205" comment="UPS1" protocolVersion="2" timeout='1' retries='2'/>
    <item name="node2" ip="test.net-snmp.org" comment="UPS2"/>
    <item name="node3" ip="10.16.11.3" comment="UPS3"/>
  </Nodes>
  <MIBdirs>
      <dir path="conf/" mask="*.mib"/>
      <dir path="conf2/" mask="*.mib"/>
  </MIBdirs>
  <Parameters defaultReadCommunity="demopublic" defaultWriteCommunity="demoprovate">
    <item name="uptime" OID="1.3.6.1.2.1.1.3.0" r_community="demopublic"/>
    <item name="uptimeName" ObjectName="sysUpTime.0"/>
    <item name="bstatus" OID="1.3.6.1.2.1.33.1.2.1.0" ObjectName="BatteryStatus"/>
    <item name="btime" OID=".1.3.6.1.2.1.33.1.2.2.0" ObjectName="TimeOnBattery"/>
    <item name="bcharge" OID=".1.3.6.1.2.1.33.1.2.4.0" ObjectName="BatteryCharge"/>
    <item name="sysName" ObjectName="sysName.0" w_community="demoprivate" r_community="demopublic"/>
  </Parameters>
</SNMP>

def uts_create_from_xml(xmlConfNode):
    """
    Создание интерфейса
    :param xmlConfNode: xml-узел с настройками
    :return: объект наследник UTestInterface
    """
    return UTestInterfaceScripts(xmlConfNode=xmlConfNode)


def uts_plugin_name():
    return "scripts"

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from TestSuiteGlobal import *


class UTestInterface():
    """Базовый интерфейс тестирования"""

    def __init__(self, itype, **kwargs):
        self.itype = itype
        self.ignore_nodes = False

    def set_ignore_nodes(self, state):
        """
        set ignore 'node' for tests (id@node)
        :param state: TRUE or FALSE
        """
        self.ignore_nodes = state

    def get_interface_type(self):
        return self.itype

    def get_conf_filename(self):
        return ''

    def validate_parameter(self, name):
        """
        Validate test parameter (id@node)
        :param name: parameter from <check> or <action>
        :return: [ RESULT, ERROR ]
        """
        return [False, "(validateParam): Unknown interface.."]

    def validate_configuration(self):
        """
        Validate configuration parameters  (check-scenario-mode)
        :return: [ RESULT, ERROR ]
        """
        return [False, "(validateConfiguration): Unknown interface.."]

    def get_value(self, name):
        raise TestSuiteException("(getValue): Unknown interface..")

    def set_value(self, name, value, supplier_id):
        raise TestSuiteException("(setValue): Unknown interface...")

  @staticmethod
    def parse_name(name, context):
        """
        Разбор строки вида: <check test="scriptname=XXX" params="param1 param2 param3" .../>
        :param name: исходный параметр (по сути и есть наш scriptname)
        :param context:
        :return: [scriptname, parameters]
        """

        if 'xmlnode' in context:
            xmlnode = context['xmlnode']
            return [name, uglobal.to_str(xmlnode.prop("params"))]

        return [name, ""]

def get_value(self, name, context):

      xmlnode = None
      if 'xmlnode' in context:
          xmlnode = context['xmlnode']

      if not xmlnode:
         raise TestSuiteException("(scripts:get_value): Unknown xmlnode for '%s'" % name)

      scriptname, params = self.parse_name(name, context)

      if len(scriptname) == 0:
         raise TestSuiteException("(scripts:get_value): Unknown script name for '%s'" % name)

      test_env = None
      if 'environment' in context:
          test_env = context['environment']

      s_out = ''
      s_err = ''
      cmd = scriptname + " " + params

      try:
          p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=test_env, close_fds=True, shell=True)

          s_out = p.stdout.read(self.max_read)
          s_err = p.stderr.read(self.max_read)
          retcode = p.wait()
          if retcode != 0:
             emessage = "SCRIPT RETCODE(%d) != 0. stderr: %s" % (retcode, s_err.replace("\n", " "))
             raise TestSuiteException("(scripts:get_value): %s" % emessage)

      except subprocess.CalledProcessError, e:
          raise TestSuiteException("(scripts:get_value): %s for %s" % (e.message, name))

      if xmlnode.prop("show_output"):
         print s_out

      ret = self.re_result.findall(s_out)
      if not ret or len(ret) == 0:
         return None

      lst = ret[0]
      if not lst or len(lst) < 1:
         return None

      return uglobal.to_int(lst)

<?xml version="1.0" encoding="utf-8"?>
<TestScenario>
  <Config>
    <environment>
      <item name="MyTEST_VAR1" value="MyTEST_VALUE1"/>
      <item name="MyTEST_VAR2" value="MyTEST_VALUE2"/>
      <item name="MyTEST_VAR3" value="MyTEST_VALUE3"/>
    </environment>
    <aliases>
      <item type="scripts" alias="s" default="1"/>
    </aliases>
  </Config>
  <TestList type="scripts">
    <test name="Test run script" ignore_failed="1">
      <check test="./test-script.sh != 10" params="--param1 3 --param2 4" timeout="2000"/>
      <check test="./test-script.sh = 100" params="param1=3,param2=4"/>
      <check test="./test-script-negative-number.sh = -20"  show_output="1"/>
      <check test="./test-script-longtime.sh = 100" timeout="3000"/>
      <check test="./test-script-error.sh > 10"/>
    </test>
  </TestList>
</TestScenario>

#!/bin/sh
echo "TEST SCRIPT: $*"
echo "SHOW OUTOUT..."
echo "TEST_SCRIPT_RESULT: 100"

#!/bin/sh
echo "TEST SCRIPT: $*"

echo  "SHOW ENV VARIABLES: .."
env | grep MyTEST
env | grep UNISET_TESTSUITE

echo "TEST_SCRIPT_RESULT: -20"

uniset2-testsuite-xmlplayer --testfile tests-scripts-interface.xml --log-show-actions --log-show-tests

   def set_value(self, name, value, context):
        raise TestSuiteException("(scripts:set_value): Function 'set' is not supported. Use <action script='..'> for %s" % name)

    def validate_configuration(self, context):
        return [True, ""]

    def validate_parameter(self, name, context):
        """
        :param name:  scriptname
        :param context: ...
        :return: [Result, errors]
        """
        err = []

        xmlnode = None
        if 'xmlnode' in context:
            xmlnode = context['xmlnode']

        scriptname, params = self.parse_name(name, context)

        if not scriptname:
            err.append("(scripts:validate): ERROR: Unknown scriptname for %s" % str(xmlnode))

        if not is_executable(scriptname):
            err.append("(scripts:validate): ERROR: '%s' not exist" % scriptname)

        if len(err) > 0:
            return [False, ', '.join(err)]

        return [True, ""]

<?xml version="1.0" encoding="utf-8"?>
<TestScenario>
  <Config>
    <environment>
      <item name="MyTEST_VAR1" value="MyTEST_VALUE1"/>
      <item name="MyTEST_VAR2" value="MyTEST_VALUE2"/>
      <item name="MyTEST_VAR3" value="MyTEST_VALUE3"/>
    </environment>
    <aliases>
      <item type="scripts" alias="s" default="1"/>
    </aliases>
  </Config>
  <TestList type="scripts">
    <test name="Test run script" ignore_failed="1">
      <check test="./test-script.sh != 10" params="--param1 3 --param2"/>
      <check test="./test-script.sh = 100" params="param1=3,param2=4"/>
      <check test="./test-script-negative-number.sh = -20"  show_output="1"/>
      <check test="./test-script-longtime.sh = 100" timeout="3000"/>
      <check test="./test-script-error.sh > 10"/>
      <check test="./non-existent-script.sh > 10"/>
    </test>
  </TestList>
</TestScenario>

uniset2-testsuite-xmlplayer --testfile tests-scripts-interface.xml --log-show-actions --log-show-tests --check-scenario

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import os
import sys
import re
import subprocess
from UTestInterface import *
import uniset2.UGlobal as uglobal


class UTestInterfaceScripts(UTestInterface):
    """
    Тестовый интерфейс основанный на вызове скриптов.

    ФОРМАТ ТЕСТА: <check test="testscript=VALUE" params="param1 param2 param3.." show_output="1".../>
    РЕЗУЛЬТАТ: В качестве результата скрипт должен вывести на экран (stdout) строку TEST_SCRIPT_RESULT: VALUE
    ОШИБКИ: Если код возврата !=0 считается что произошла ошибка! В случае успеха скрипт должен вернуть код возврата 0.

    Дополнительные параметры:
        show_output=1 - вывести на экран stdout..

    Глобальные конфигурационные параметры (секция <Config>):
      max_output_read="value" - максимальное количество первых байт читаемое из вывода скрипта, чтобы получить результат.
      По умолчанию: 1000
    """

    def __init__(self, **kwargs):
        """
        :param kwargs: параметры
        """
        UTestInterface.__init__(self, 'scripts', **kwargs)

        self.max_read = 1000

        if 'xmlConfNode' in kwargs:
            xmlConfNode = kwargs['xmlConfNode']
            if not xmlConfNode:
                raise TestSuiteValidateError("(scripts:init): Unknown confnode")

            m_read = uglobal.to_int(xmlConfNode.prop("max_output_read"))
            if m_read > 0:
                self.max_read = m_read

        self.re_result = re.compile(r'TEST_SCRIPT_RESULT: ([-]{0,}\d{1,})')

    @staticmethod
    def parse_name(name, context):
        """
        Разбор строки вида: <check test="scriptname=XXX" params="param1 param2 param3" .../>
        :param name: исходный параметр (по сути и есть наш scriptname)
        :param context:
        :return: [scriptname, parameters]
        """

        if 'xmlnode' in context:
            xmlnode = context['xmlnode']
            return [name, uglobal.to_str(xmlnode.prop("params"))]

        return [name, ""]

    def validate_configuration(self, context):
        return [True, ""]

    def validate_parameter(self, name, context):
        """

        :param name:  scriptname
        :param context: ...
        :return: [Result, errors]
        """
        err = []

        xmlnode = None
        if 'xmlnode' in context:
            xmlnode = context['xmlnode']

        scriptname, params = self.parse_name(name, context)

        if not scriptname:
            err.append("(scripts:validate): ERROR: Unknown scriptname for %s" % str(xmlnode))

        if not is_executable(scriptname):
            err.append("(scripts:validate): ERROR: '%s' not exist" % scriptname)

        if len(err) > 0:
            return [False, ', '.join(err)]

        return [True, ""]

    def get_value(self, name, context):

        xmlnode = None
        if 'xmlnode' in context:
            xmlnode = context['xmlnode']

        if not xmlnode:
            raise TestSuiteException("(scripts:get_value): Unknown xmlnode for '%s'" % name)

        scriptname, params = self.parse_name(name, context)

        if len(scriptname) == 0:
            raise TestSuiteException("(scripts:get_value): Unknown script name for '%s'" % name)

        test_env = None
        if 'environment' in context:
            test_env = context['environment']

        s_out = ''
        s_err = ''

        cmd = scriptname + " " + params

        try:
            p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=test_env, close_fds=True,
                                 shell=True)

            s_out = p.stdout.read(self.max_read)
            s_err = p.stderr.read(self.max_read)

            retcode = p.wait()

            if retcode != 0:
                emessage = "SCRIPT RETCODE(%d) != 0. stderr: %s" % (retcode, s_err.replace("\n", " "))
                raise TestSuiteException("(scripts:get_value): %s" % emessage)

        except subprocess.CalledProcessError, e:
            raise TestSuiteException("(scripts:get_value): %s for %s" % (e.message, name))

        if xmlnode.prop("show_output"):
            print s_out

        ret = self.re_result.findall(s_out)
        if not ret or len(ret) == 0:
            return None

        lst = ret[0]
        if not lst or len(lst) < 1:
            return None

        return uglobal.to_int(lst)

    def set_value(self, name, value, context):
        raise TestSuiteException(
            "(scripts:set_value): Function 'set' is not supported. Use <action script='..'> for %s" % name)


def uts_create_from_args(**kwargs):
    """
    Создание интерфейса
    :param kwargs: именованные параметры
    :return: объект наследник UTestInterface
    """
    return UTestInterfaceScripts(**kwargs)


def uts_create_from_xml(xmlConfNode):
    """
    Создание интерфейса
    :param xmlConfNode: xml-узел с настройками
    :return: объект наследник UTestInterface
    """
    return UTestInterfaceScripts(xmlConfNode=xmlConfNode)


def uts_plugin_name():
    return "scripts"