Skip to main content

Continuous testing & Linting Documentation Status Build Status Py Versions License

img-proof

overview

img-proof (IPA) provides a command line utility to test images in the Public Cloud (AWS, Azure, GCE, etc.).

With img-proof you can now test custom images in a cloud framework agnostic way with one tool and one API. In the first release, img-proof supports the openSUSE and SLES distributions. It also supports the three largest cloud frameworks (AWS, Azure and GCE). However, it is intended to be distribution agnostic and framework transparent so both are easily extensible.

For each distribution there are specific synchronization points that must be provided. These currently include soft reboot and system update. The synch points not only test functionality but also act as dividers to separate distinct sections of a test suite. For example you can run a test to ensure the proper repos exist before and after a system update. The system update synch point will guarantee the order of tests. Speaking of tests, if you're already familiar with Pytest conventions there's no need to learn a whole new unit testing framework. img-proof is written in Python and leverages the Pytest framework through Testinfra.

Installation

To install the package use the following commands as root:

$ zypper ar http://download.opensuse.org/repositories/Cloud:/Tools:/CI/<distribution>
$ zypper refresh
$ zypper in python-img-proof

Requirements

  • boto3
  • apache-libcloud
  • azure-common
  • azure-mgmt-compute
  • azure-mgmt-network
  • azure-mgmt-resource
  • Click
  • paramiko
  • pytest
  • PyYaml
  • testinfra
  • oci

Docs

Tests

img-proof uses the Testinfra package for writing unit tests. Testinfra leverages Pytest and provides modules such as Package, Process and Service to test the state of images. See the Testinfra Docs for more information on writing infrastructure tests.

img-proof currently passes the Pytest option -x (stop on first failure) through as --early-exit. If there's an interest or need for any other options/args please submit an issue to Github.

CLI Overview

The CLI provides multiple subcommands to initiate image testing:

  • img-proof test

    Test image in the given framework using the supplied test files.

  • img-proof results

    Invokes the default show subcommand img-proof results show 1.

  • img-proof results clear

    Clear the results from the history file.

  • img-proof results delete

    Delete the specified history item from the history log.

  • img-proof results list`

    Display list of results history.

  • img-proof results show

    Display the results or log file for a history item.

  • img-proof list

    Print a list of test files or test cases.

Issues/Enhancements

Please submit issues and requests to Github.

Contributing

Contributions to ipa are welcome and encouraged. See CONTRIBUTING for info on getting started.

License

Copyright (c) 2018 SUSE LLC.

Distributed under the terms of GPL-3.0+ license, see LICENSE for details.

Metadata

Release files for img-proof 9.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for img-proof 9.20.0
File Size Uploaded
img_proof-9.20.0.tar.gz 112.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for img-proof 9.20.0
File Interpreter ABI Platform
img_proof-9.20.0-py3-none-any.whl Python 3 none any Details

Total release size: 181.3 kB

Release files / img_proof-9.20.0.tar.gz

Download URL img_proof-9.20.0.tar.gz
Size 112.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7522c84e1a5395c332d8876a2470d07c9776fbd8bf044b948a6b30e125bd5aab
BLAKE2b-256 checksum
How to use checksums
43a0ff3618431145fbfbb3302e6246e114012f27a78f4d10f415fa954762da31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / img_proof-9.20.0-py3-none-any.whl

Download URL img_proof-9.20.0-py3-none-any.whl
Size 68.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7e9533f3848fe49d4c33e92ae570701a9a67e6a3caf447240d24e6fdbbbf1b20
BLAKE2b-256 checksum
How to use checksums
eed70734e24d893207938b60ba6a09bad2c3dd18a1ec3cb2e0298375d331224c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

9.21.0

2 release files

This release

9.20.0 This release

2 release files

9.18.0

2 release files

9.17.0

2 release files

9.16.0

2 release files

9.15.0

2 release files

9.14.0

2 release files

9.13.2

2 release files

9.13.1

2 release files

9.13.0

2 release files

9.12.0

2 release files

9.9.0

2 release files

9.8.0

2 release files

9.7.0

2 release files

9.6.0

2 release files

9.5.0

2 release files

9.4.0

2 release files

9.3.0

2 release files

9.2.0

2 release files

9.1.0

2 release files

9.0.0

2 release files

8.4.0

2 release files

8.3.0

2 release files

8.2.0

2 release files

8.1.0

2 release files

8.0.1

2 release files

8.0.0

2 release files

7.36.0

2 release files

7.35.0

2 release files

7.34.0

2 release files

7.33.0

2 release files

7.32.0

2 release files

7.31.0

2 release files

7.30.0

2 release files

7.29.7

2 release files

7.29.6

2 release files

7.29.5

2 release files

7.29.4

2 release files

7.29.3

2 release files

7.29.2

2 release files

7.29.1

2 release files

7.29.0

2 release files

7.28.0

2 release files

7.25.0

2 release files

7.24.0

2 release files

7.23.0

2 release files

7.22.0

2 release files

7.19.0

2 release files

7.16.1

2 release files

7.16.0

2 release files

7.15.0

2 release files

7.14.0

2 release files

7.13.1

2 release files

7.13.0

2 release files

7.12.0

2 release files

7.11.0

2 release files

7.10.0

2 release files

7.9.1

2 release files

7.9.0

2 release files

7.8.2

2 release files

7.8.1

2 release files

7.8.0

2 release files

7.7.0

2 release files

7.6.0

2 release files

7.5.2

2 release files

7.5.1

2 release files

7.5.0

2 release files

7.4.0

2 release files

7.3.1

2 release files

7.3.0

2 release files

7.2.0

2 release files

7.1.0

2 release files

7.0.0

2 release files

6.4.0

2 release files

6.3.1

1 release file

6.3.0

1 release file

6.2.0

1 release file

6.1.0

1 release file

6.0.0

1 release file

5.3.0

1 release file

5.2.0

1 release file

5.1.0

1 release file

5.0.0

1 release file

4.8.1

1 release file

4.8.0

1 release file

4.7.0

1 release file

4.6.0

1 release file

4.5.1

1 release file

4.5.0

1 release file

4.4.0

1 release file

4.3.1

1 release file

4.3.0

1 release file

4.2.1

1 release file

4.2.0

1 release file

4.1.1

1 release file

4.1.0

1 release file

4.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page