1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
Overview
========
This document describes how to test and lint the macpkg generation scripts and
PKG.
Running the tests
-----------------
The test suite utilizes `Bats <https://github.com/sstephenson/bats>`_ to run
the tests. To run the tests, first make sure you first install Bats::
$ brew install bats
And then run Bats from within this ``tests`` directory::
$ bats .
You can point the tests to a custom installer package location by using the
environment variable INSTALLER_TO_TEST. For example to test an installer in your
home directory::
$ INSTALLER_TO_TEST=~/AWS-CLI-Installer.pkg bats .
Linting
-------
To help catch potential issues in the shell script and tests, you should also
lint the scripts. To lint the shell scripts, use
`ShellCheck <https://github.com/koalaman/shellcheck>`_. It can be installed
with ``brew``::
$ brew install shellcheck
Then run on the ``scripts/postinstall`` and ``tests/install.bats``
test files::
$ shellcheck scripts/postinstall tests/install.bats
|
