[Kimchi-devel] [PATCH v3] issue #504: Add details on how to install test dependencies

[Daniel Henrique Barboza]

Reviewed-by: Daniel Barboza <danielhb at linux.vnet.ibm.com>


On 12/09/2014 11:09 AM, Crístian Viana wrote:
> The package dependencies listed in docs/README.md are only required for
> building, installing and running Kimchi. If the user wants to run the
> tests, they need to install some extra packages which are not listed in
> that file.
>
> Update the file docs/README.md by adding the dependencies required for
> testing.
>
> Fix issue #504 ("check pyflakes installation").
>
> Signed-off-by: Crístian Viana <vianac at linux.vnet.ibm.com>
> ---
>   contrib/DEBIAN/control.in     |  3 +--
>   contrib/kimchi.spec.fedora.in |  1 -
>   contrib/kimchi.spec.suse.in   |  1 -
>   docs/README.md                | 29 +++++++++++++++++++++++------
>   4 files changed, 24 insertions(+), 10 deletions(-)
>
> diff --git a/contrib/DEBIAN/control.in b/contrib/DEBIAN/control.in
> index 7e0ed8d..6206817 100644
> --- a/contrib/DEBIAN/control.in
> +++ b/contrib/DEBIAN/control.in
> @@ -30,7 +30,6 @@ Depends: python-cherrypy3 (>= 3.2.0),
>            libguestfs-tools,
>            spice-html5
>   Build-Depends: libxslt,
> -               python-lxml,
> -               python-requests
> +               python-lxml
>   Maintainer: Aline Manera <alinefm at br.ibm.com>
>   Description: Kimchi web server
> diff --git a/contrib/kimchi.spec.fedora.in b/contrib/kimchi.spec.fedora.in
> index c1929f8..8172897 100644
> --- a/contrib/kimchi.spec.fedora.in
> +++ b/contrib/kimchi.spec.fedora.in
> @@ -33,7 +33,6 @@ Requires:	python-libguestfs
>   Requires:	libguestfs-tools
>   BuildRequires:	libxslt
>   BuildRequires:	python-lxml
> -BuildRequires:	python-requests
>   
>   %if 0%{?rhel} == 6 || 0%{?fedora} >= 19
>   Requires:	spice-html5
> diff --git a/contrib/kimchi.spec.suse.in b/contrib/kimchi.spec.suse.in
> index be75590..ad01ff6 100644
> --- a/contrib/kimchi.spec.suse.in
> +++ b/contrib/kimchi.spec.suse.in
> @@ -32,7 +32,6 @@ Requires:	python-libguestfs
>   Requires:	guestfs-tools
>   BuildRequires:	libxslt-tools
>   BuildRequires:	python-lxml
> -BuildRequires:	python-requests
>   
>   %if 0%{?sles_version} == 11
>   Requires:       python-ordereddict
> diff --git a/docs/README.md b/docs/README.md
> index ed3d489..823c856 100644
> --- a/docs/README.md
> +++ b/docs/README.md
> @@ -55,8 +55,7 @@ Install Dependencies
>                           python-ipaddr python-ldap python-lxml nfs-utils \
>                           iscsi-initiator-utils libxslt pyparted nginx \
>                           policycoreutils-python python-libguestfs \
> -                        libguestfs-tools python-requests python-websockify \
> -                        novnc
> +                        libguestfs-tools python-websockify novnc
>   
>        # If using RHEL6 or Fedora, install the following additional package:
>        $ sudo yum install spice-html5
> @@ -69,6 +68,9 @@ Install Dependencies
>       Packages version requirement:
>           python-psutil >= 0.6.0
>   
> +    # These dependencies are only required if you want to run the tests:
> +    $ sudo yum install pyflakes python-pep8 python-requests
> +
>   *Note for RHEL users*: Some of the above packages are located in the Red Hat
>   EPEL repositories.  See
>   [this FAQ](http://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F)
> @@ -88,12 +90,15 @@ channel at RHN Classic or Red Hat Satellite.
>                              python-lxml nfs-common open-iscsi lvm2 xsltproc \
>                              python-parted nginx \
>                              firewalld python-guestfs libguestfs-tools \
> -                           python-requests websockify novnc spice-html5
> +                           websockify novnc spice-html5
>   
>       Packages version requirement:
>           python-jsonschema >= 1.3.0
>           python-psutil >= 0.6.0
>   
> +    # These dependencies are only required if you want to run the tests:
> +    $ sudo apt-get install pep8 pyflakes python-requests
> +
>   **For openSUSE:**
>   
>       $ sudo zypper install gcc make autoconf automake gettext-tools git \
> @@ -103,13 +108,15 @@ channel at RHN Classic or Red Hat Satellite.
>                             rpm-build kvm python-psutil python-ethtool \
>                             python-ipaddr python-ldap python-lxml nfs-client \
>                             open-iscsi libxslt-tools python-xml \
> -                          python-parted nginx \
> -                          python-libguestfs guestfs-tools python-requests \
> -                          python-websockify novnc
> +                          python-parted nginx python-libguestfs \
> +                          guestfs-tools python-websockify novnc
>   
>       Packages version requirement:
>           python-psutil >= 0.6.0
>   
> +    # These dependencies are only required if you want to run the tests:
> +    $ sudo zypper install python-pyflakes python-pep8 python-requests
> +
>   *Note for openSUSE users*: Some of the above packages are located in different
>   openSUSE repositories. See
>   [this FAQ](http://download.opensuse.org/repositories/home:GRNET:synnefo/) for
> @@ -135,6 +142,16 @@ Run
>   
>       $ sudo kimchid --host=0.0.0.0
>   
> +
> +Test
> +----
> +
> +    $ make check-local # check for i18n and formatting errors
> +    $ sudo make check
> +
> +After all tests are executed, a summary will be displayed containing any
> +errors/failures which might have occurred.
> +
>   Usage
>   -----
>