Metadata-Version: 2.1
Name: awssert
Version: 0.0.3
Summary: Declarative assertions for AWS
Home-page: https://github.com/TSNoble/awssert
Author: Tom Noble
Author-email: t.s.noble@outlook.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/TSNoble/awssert/issues
Project-URL: Source, https://github.com/TSNoble/awssert
Description: # AWSsert
        
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/TSNoble/awssert/Test)
        ![PyPI](https://img.shields.io/pypi/v/awssert)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/awssert)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        AWSsert is a Python library providing declarative assertions about AWS resources to your tests.
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install AWSsert.
        
        ```bash
        pip install awssert
        ```
        
        ## Usage
        
        AWSsert attaches assertions directly to [boto3](https://github.com/boto/boto3) resource objects, allowing you to write clean and declarative tests:
        
        ```python
        import boto3
        
        from awssert.fixtures import awssert
        
        def test_bucket_contains_object(awssert):
           bucket = boto3.resource("s3").Bucket("foo")
           assert bucket.should_not.contain("bar")
           bucket.put_object(Key="bar", Body=b"123")
           assert bucket.should_contain("bar")
        ```
        
        AWSsert also works in tandem with [moto](https://pypi.org/project/moto/), enabling the same level of clarity to be applied on mock infrastructure:
        
        ```python
        import boto3
        import moto
        import pytest
        
        from awssert.fixtures import awssert
        
        @pytest.fixture
        def mock_s3():
           with moto.mock_s3():
              yield
        
        def test_bucket_contains_object(mock_s3, awssert):
           bucket = boto3.resource("s3").Bucket("foo")
           assert bucket.should_not.contain("bar")
           bucket.put_object(Key="bar", Body=b"123")
           assert bucket.should_contain("bar")
        ```
        
        Note that AWSsert currently only works with moto usage of the fixture form, which must be included in a test __before__ the awssert fixture.
        
        ## Progress
        TODO
        
        
        ## Contributing
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        Please make sure to update tests as appropriate.
        
        ## License
        [Apache Software License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
Keywords: aws,python,pytest,boto3,testing
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Framework :: AWS CDK
Classifier: Framework :: Pytest
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
