Yasuke/moto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(readme): Align code snippets formatting with project's rules. (#5802)

Browse Source
This commit is contained in:
Paweł Rubin 2022-12-22 15:34:17 +01:00 committed by GitHub
parent 5920d1a8ce
commit f5fbddec86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -27,14 +27,15 @@ Imagine you have the following python code that you want to test:
```python ```python
import boto3 import boto3
class MyModel(object):
class MyModel:
def __init__(self, name, value): def __init__(self, name, value):
self.name = name self.name = name
self.value = value self.value = value
def save(self): def save(self):
s3 = boto3.client('s3', region_name='us-east-1') s3 = boto3.client("s3", region_name="us-east-1")
s3.put_object(Bucket='mybucket', Key=self.name, Body=self.value) s3.put_object(Bucket="mybucket", Key=self.name, Body=self.value)
``` ```
Take a minute to think how you would have tested that in the past. Take a minute to think how you would have tested that in the past.
@ -46,15 +47,16 @@ import boto3
from moto import mock_s3 from moto import mock_s3
from mymodule import MyModel from mymodule import MyModel
@mock_s3 @mock_s3
def test_my_model_save(): def test_my_model_save():
conn = boto3.resource('s3', region_name='us-east-1') conn = boto3.resource("s3", region_name="us-east-1")
# We need to create the bucket since this is all in Moto's 'virtual' AWS account # We need to create the bucket since this is all in Moto's 'virtual' AWS account
conn.create_bucket(Bucket='mybucket') conn.create_bucket(Bucket="mybucket")
model_instance = MyModel('steve', 'is awesome') model_instance = MyModel("steve", "is awesome")
model_instance.save() model_instance.save()
body = conn.Object('mybucket', 'steve').get()['Body'].read().decode("utf-8") body = conn.Object("mybucket", "steve").get()["Body"].read().decode("utf-8")
assert body == 'is awesome' assert body == "is awesome"
``` ```
With the decorator wrapping the test, all the calls to s3 are automatically mocked out. The mock keeps the state of the buckets and keys. With the decorator wrapping the test, all the calls to s3 are automatically mocked out. The mock keeps the state of the buckets and keys.