# salt.modules.test

Module for running arbitrary tests

`salt.modules.test.` `arg`(*args, **kwargs)

  Print out the data passed into the function `*args` and ``kwargs`, this is used to both test the publication data and cli argument passing, but also to display the information available within the publication data. Returns {"args": args, "kwargs": kwargs}.

  CLI Example:

      salt '*' test.arg 1 "two" 3.1 txt="hello" wow='{a: 1, b: "hello"}'

`salt.modules.test.` `arg_repr`(*args, **kwargs)

  Print out the data passed into the function `*args` and ``kwargs`, this is used to both test the publication data and cli argument passing, but also to display the information available within the publication data. Returns {"args": repr(args), "kwargs": repr(kwargs)}.

  CLI Example:

      salt '*' test.arg_repr 1 "two" 3.1 txt="hello" wow='{a: 1, b: "hello"}'

`salt.modules.test.` `arg_type`(*args, **kwargs)

  Print out the types of the args and kwargs. This is used to test the types of the args and kwargs passed down to the minion

`salt.modules.test.` `collatz`(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:

      salt '*' test.collatz 3

`salt.modules.test.` `conf_test`()

  Return the value for test.foo in the minion configuration file, or return the default value

  CLI Example:

      salt '*' test.conf_test

`salt.modules.test.` `cross_test`(func, args=None)

  Execute a minion function via the __salt__ object in the test module, used to verify that the minion functions can be called via the __salt__ module.

  CLI Example:

      salt '*' test.cross_test file.gid_to_group 0

`salt.modules.test.` `echo`(text)

  Return a string - used for testing the connection

  CLI Example:

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

`salt.modules.test.` `fib`(num)

  Return a Fibonacci sequence up to the passed number, and the timeit took to compute in seconds. Used for performance tests

  CLI Example:

      salt '*' test.fib 3

`salt.modules.test.` `get_opts`()

  Return the configuration options passed to this minion

  CLI Example:

      salt '*' test.get_opts

`salt.modules.test.` `kwarg`(**kwargs)

  Print out the data passed into the function `**kwargs`, this is used to both test the publication data and cli kwarg passing, but also to display the information available within the publication data.

  CLI Example:

      salt '*' test.kwarg num=1 txt="two" env='{a: 1, b: "hello"}'

`salt.modules.test.` `not_loaded`()

  List the modules that were not loaded by the salt loader system

  CLI Example:

      salt '*' test.not_loaded

`salt.modules.test.` `opts_pkg`()

  Return an opts package with the grains and opts for this minion. This is primarily used to create the options used for master side state compiling routines

  CLI Example:

      salt '*' test.opts_pkg

`salt.modules.test.` `outputter`(data)

  Test the outputter, pass in data to return

  CLI Example:

      salt '*' test.outputter foobar

`salt.modules.test.` `ping`()

  Just used to make sure the minion is up and responding Return True

  CLI Example:

      salt '*' test.ping

`salt.modules.test.` `provider`(module)

  Pass in a function name to discover what provider is being used

  CLI Example:

      salt '*' test.provider service

`salt.modules.test.` `providers`()

  Return a dict of the provider names and the files that provided them

  CLI Example:

      salt '*' test.providers

`salt.modules.test.` `rand_sleep`(max=60)

  Sleep for a random number of seconds, used to test long-running commands and minions returning at differing intervals

  CLI Example:

      salt '*' test.rand_sleep 60

`salt.modules.test.` `retcode`(code=42)

  Test that the returncode system is functioning correctly

  CLI Example:

      salt '*' test.retcode 42

`salt.modules.test.` `sleep`(length)

  Instruct the minion to initiate a process that will sleep for a given period of time.

  CLI Example:

      salt '*' test.sleep 20

`salt.modules.test.` `tty`(device, echo=None)

  Echo a string to a specific tty

  CLI Example:

      salt '*' test.tty tty0 'This is a test'
      salt '*' test.tty pts3 'This is a test'

`salt.modules.test.` `version`()

  Return the version of salt on the minion

  CLI Example:

      salt '*' test.version

`salt.modules.test.` `versions_information`()

  Returns versions of components used by salt as a dict

  CLI Example:

      salt '*' test.versions_information

`salt.modules.test.` `versions_report`()

  Returns versions of components used by salt

  CLI Example:

      salt '*' test.versions_report

Current Salt release: 0.17.1

#### Previous topic

salt.modules.systemd

#### Next topic

salt.modules.timezone

### Quick search

Enter search terms or a module, class or function name.

### Upcoming SaltStack Events

My conferences on Lanyrd