saltstack/salt

'''
Module for running arbitrary tests
'''

import time


def echo(text):
    '''
    Return a string - used for testing the connection

    CLI Example:

    .. code-block:: bash

        salt '*' test.echo 'foo bar baz quo qux'
    '''
    return text


def ping():
    '''
    Just used to make sure the minion is up and responding
    Return True

    CLI Example:

    .. code-block:: bash

        salt '*' test.ping
    '''
    return True


def fib(long num):
    '''
    Return a Fibonacci sequence up to the passed number, and the time it took
    to compute in seconds. Used for performance tests

    CLI Example:

        salt '*' test.fib 3
    '''
    cdef float start = time.time()
    cdef long a = 0
    cdef long b = 1
    ret = [0]
    while b < num:
        ret.append(b)
        a, b = b, a + b
    cdef float end = time.time() - start
    return ret, end


def collatz(long start):
    '''
    Execute the collatz conjecture from the passed starting number, returns
    the sequence and the time it took to compute. Used for performance tests.

    CLI Example:

    .. code-block:: bash

        salt '*' test.collatz 3
    '''
    cdef float begin = time.time()
    steps = []
    while start != 1:
        steps.append(start)
        if start > 1:
            if start % 2 == 0:
                start = start / 2
            else:
                start = start * 3 + 1
    cdef float end = time.time() - begin
    return steps, end