mosadm run-smoke-tests

Run smoke tests on MATLAB Online Server

collapse all in page

    Syntax

    mosadm run-smoke-tests
    mosadm run-smoke-tests option1 ... optionN

    Description

    mosadm run-smoke-tests runs smoke tests on MATLAB® Online Server™.

    Smoke tests reveal simple failures severe enough to impact operations. The smoke test tool that comes with MATLAB Online Server runs a set of tests against a MATLAB Online Server implementation. The tool returns information on installation setup, Kubernetes® elements, and the MATLAB Online Server microservices. The information provided by these smoke tests can help focus troubleshooting strategies for MATLAB Online Server.

    Note

    To run smoke tests, verify that your system meets the prerequisites specified in Smoke Test Prerequisites

    For details on interpreting the results, see Address Smoke Test Failures

    example

    mosadm run-smoke-tests option1 ... optionN runs smoke tests using the specified configuration options.

    Note

    mosadm run-smoke-tests interacts with Docker®. If you do not have sudo administration privileges for Docker, then this command also requires sudo.

    example

    Examples

    collapse all

    sudo ./mosadm run-smoke-tests
    YYYY/MM/DD hh:mm:ss Smoke-Tests---------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss    Commands---------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss       docker : PASS
YYYY/MM/DD hh:mm:ss       kubectl : PASS
YYYY/MM/DD hh:mm:ss       helm : PASS
YYYY/MM/DD hh:mm:ss    Commands : PASS
YYYY/MM/DD hh:mm:ss    -----------------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss    Properties-------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss       DomainBaseLookup : PASS
YYYY/MM/DD hh:mm:ss       DomainBaseSecurelyReachable : PASS
YYYY/MM/DD hh:mm:ss    Properties : PASS
...
    sudo ./mosadm run-smoke-tests --verbose
    YYYY/MM/DD hh:mm:ss Smoke-Tests---------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss    Commands---------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss       docker--------------------------------------------------------------------
YYYY/MM/DD hh:mm:ss          docker version : Client:
                              Version:           20.10.12
                              API version:       1.41
                              Go version:        go1.17.3
                              Git commit:        20.10.12-0ubuntu4
                              Built:             Mon Mar  7 17:10:06 YYYY
                              OS/Arch:           linux/amd64
                              Context:           default
                              Experimental:      true
                              ...

    Input Arguments

    collapse all

    One or more configuration options, specified as strings corresponding to valid configuration options from these tables.

    Specific to mosadm run-smoke-tests

    OptionDescription
    --container-log-tail-lines numLines

    Number of lines from the end of the container log to display.

    Default: 100

    --deployment-image-registry registryName

    Image registry to use for the deployment.

    Example: registry.yourcompany.com

    --deployment-image-repository repositoryName

    Image repository to use for the deployment images.

    Example: mathworks

    --domain-base domainBaseName

    Domain where MATLAB Online Server is running. By default, domainBaseName is the value of the DOMAIN_BASE property of the install.config file.

    --image-flavor imageFlavorName

    Container image flavor, specified as debian or rhel.

    Default: debian

    --license-port portNum

    Port number used to connect to MathWorks® License Manager. Specify portNum as a numeric string representing a valid port number.

    Default: 8080

    --no-certificate-check

    If the certificate deployed at MATLAB Online Server does not match its domain, many tests fail. Specify this argument to ignore this certificate mismatching.

    --no-secure-http

    If no certificate is deployed at MATLAB Online Server, run tests that require HTTP calls using only nonsecure HTTP. Use this option to check whether MATLAB Online Server is deployed properly before deploying the appropriate certificate. If you specify this option, then mosadm run-smoke-tests ignores the --no-certificate-check option.

    --no-terminal-colors

    Skip printing output using the default terminal colors to aid accessibility.

    --skip-tests testName1 ... testNameN

    Names of tests to be skipped.

    --time-out numSeconds

    Number of seconds to wait to start running tests before canceling the operation.

    Default: 5

    Common to All mosadm Commands

    OptionDescription

    --charts-dir chartsDir

    Name of the MATLAB Online Server charts folder to use. This folder contains the Helm® charts of the server.

    Specify chartsDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/charts.

    Default: mosRoot/charts

    --data-dir dataDir

    Name of the MATLAB Online Server data folder to use.

    Specify dataDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/data.

    Default: mosRoot/data

    --dry-run

    Print out the commands that would have run without this option specified but do not run the operation. Specify this option to test that the operation produces the expected results before actually executing it.

    --help, -h, help

    		Output help for mosadm run-smoke-tests to the command line.

    --kube-config configFilePath

    Path to the Kubernetes cluster configuration file. Specify configFilePath as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: /etc/kubernetes/admin.conf

    By default, configFilePath is empty and Kubernetes obtains the cluster configuration from the KUBECONFIG environment variable (if specified) or the ~/.kube/config file. If you run mosadm run-smoke-tests with sudo, then ~/.kube/config is equivalent to /root/.kube/config.

    --mos-root rootDir

    MATLAB Online Server root folder, specified as an absolute path or a path relative to the current folder, that is, the folder in which you can run mosadm commands.

    Default: . (current folder)

    --overrides-dir overridesDir

    Name of the MATLAB Online Server overrides folder to use.

    Specify overridesDir as an absolute path or a path relative to the MATLAB Online Server root folder, mosRoot.

    Example: matlab_online_server/overrides

    Default: mosRoot/overrides

    --quiet, -q

    Print only the most useful or relevant output from the mosadm run-smoke-tests command.

    --skip-log-file

    Skip creating the install.log file and logging data about the mosadm run-smoke-tests operation to this file.

    --skip-prompt, -y

    Force acceptance of the terms of use for the mosadm run-smoke-tests and skip any command-line prompts normally provided when calling this command.

    --tmp-dir tempDirName

    Name of MATLAB Online Server temporary folder to use.

    Specify tempDirName as an absolute path or a path relative to the temporary folder.

    By default, mosadm run-smoke-tests generates a new temporary folder every time you run the command.

    --verbose

    Output extra details about the mosadm run-smoke-tests operation to the command line.

    More About

    collapse all

    Version History

    Introduced in R2020a

    See Also

    Topics