Merge pull request #181 from thenewboston-developers/BC-72-swagger

BC-72 Add and configure drf-spectacular module.

Author: dmugtasimov

.pre-commit-config.yaml

@@ -42,4 +42,4 @@ repos:
     rev: 'v0.910'
     hooks:
       - id: mypy
-        additional_dependencies: [types-requests, types-PyYAML]
+        additional_dependencies: [types-requests, types-PyYAML, types-toml]

node/blockchain/admin.py

@@ -12,4 +12,4 @@ class BlockAdmin(admin.ModelAdmin):
 
 @admin.register(AccountState)
 class AccountStateAdmin(admin.ModelAdmin):
-    pass
+    list_display = ('_id',)

node/blockchain/serializers/account_state.py

@@ -6,6 +6,7 @@
 
 
 class AccountStateSerializer(serializers.ModelSerializer):
+
     _id = serializers.CharField()
     balance = serializers.IntegerField()
     account_lock = serializers.CharField()

node/blockchain/serializers/node.py

@@ -4,6 +4,7 @@
 
 
 class NodeSerializer(serializers.ModelSerializer):
+
     # TODO(dmu) HIGH: Instead of redefining serializer fields generate serializer from
     #                 Node model metadata
     identifier = serializers.CharField()

node/blockchain/serializers/signed_change_request.py

@@ -15,6 +15,7 @@
 
 
 class SignedChangeRequestSerializer(serializers.Serializer, ValidateUnknownFieldsMixin):
+
     signer = serializers.CharField()
     signature = serializers.CharField()
     message = PydanticModelBackedJSONField()

node/blockchain/tests/fixtures/blockchain.py

@@ -2,6 +2,9 @@
 
 from node.blockchain.facade import BlockchainFacade
 from node.blockchain.tests.factories.node import make_node
+from node.blockchain.tests.factories.signed_change_request.coin_transfer import (
+    make_coin_transfer_signed_change_request
+)
 from node.blockchain.tests.factories.signed_change_request.node_declaration import (
     make_node_declaration_signed_change_request
 )
@@ -22,14 +25,10 @@ def base_blockchain(genesis_block_message, primary_validator_key_pair, db):
 
 @pytest.fixture
 def rich_blockchain(
-    base_blockchain,
-    primary_validator_key_pair,
-    confirmation_validator_key_pair,
-    confirmation_validator_key_pair_2,
-    regular_node_declaration_signed_change_request,
-    self_node_declaration_signed_change_request,
+    base_blockchain, primary_validator_key_pair, confirmation_validator_key_pair, confirmation_validator_key_pair_2,
+    regular_node_declaration_signed_change_request, self_node_declaration_signed_change_request,
     confirmation_validator_declaration_signed_change_request,
-    confirmation_validator_2_declaration_signed_change_request,
+    confirmation_validator_2_declaration_signed_change_request, treasury_account_key_pair, regular_node, self_node
 ):
     blockchain_facade = BlockchainFacade.get_instance()
 
@@ -67,6 +66,14 @@ def rich_blockchain(
         validate=False,
     )
 
+    blockchain_facade.add_block_from_signed_change_request(
+        signed_change_request=make_coin_transfer_signed_change_request(
+            treasury_account_key_pair, regular_node.identifier, self_node.identifier
+        ),
+        signing_key=primary_validator_key_pair.private,
+        validate=False,
+    )
+
     # TODO(dmu) MEDIUM: Add more blocks as new block types are developed
 
 

node/blockchain/tests/test_management/test_send_signed_change_request.py

@@ -63,7 +63,7 @@ def test_coin_transfer(
     _, output = out.getvalue().split('Response (raw):')
     assert json.loads(output) == {
         'message': {
-            'account_lock': '4d3cf1d9e4547d324de2084b568f807ef12045075a7a01b8bec1e7f013fc3732',
+            'account_lock': '572795e9eb525f7c5ff601b001e8c13bac148b488fbe0142dfdaa6841148648d',
             'txs': [{
                 'amount': 100,
                 'is_fee': False,
@@ -78,8 +78,8 @@ def test_coin_transfer(
             'type': 2
         },
         'signature':
-            '628b293aeceec992d094c62f60f5031879b4893047f4c4ab158e506c04b916b0'
-            '489b5a750d3b1af7cfe9b99c03253424b483450bcafe1b1f608529cad012a502',
+            '07f11055cba3d968123d2312e7d46cf95ad18be057b5ba0c1cb3c72670e5bee5'
+            '70a7fbbb2f33ae4888a314d05142353d3472cf51ba5726aa12be01655bfbc906',
         'signer': '4d3cf1d9e4547d324de2084b568f807ef12045075a7a01b8bec1e7f013fc3732'
     }
 
@@ -92,10 +92,10 @@ def test_pv_schedule_update(
     out = StringIO()
     blockchain_facade = BlockchainFacade.get_instance()
 
-    assert blockchain_facade.get_next_block_number() == 6
+    assert blockchain_facade.get_next_block_number() == 7
 
     schedule = {
-        '6': primary_validator_key_pair.public,
+        '7': primary_validator_key_pair.public,
     }
     call_command(
         'add_signed_change_request', '3', 'local', self_node_key_pair.private, json.dumps(schedule), stdout=out

node/blockchain/tests/test_models/test_block/test_pv_schedule_update.py

@@ -166,7 +166,7 @@ def test_validate_nodes_are_declared(primary_validator_key_pair):
 @pytest.mark.usefixtures('rich_blockchain')
 def test_validate_block_numbers(schedule_keys, exception_match, primary_validator_node, self_node_key_pair):
     blockchain_facade = BlockchainFacade.get_instance()
-    assert blockchain_facade.get_next_block_number() == 6
+    assert blockchain_facade.get_next_block_number() == 7
 
     schedule = {k: primary_validator_node.identifier for k in schedule_keys}
 

node/blockchain/tests/test_rest_api/test_block.py

@@ -7,6 +7,7 @@
 from node.blockchain.models import Block, PendingBlock
 from node.blockchain.tests.factories.block import make_block
 from node.blockchain.tests.factories.block_message.node_declaration import make_node_declaration_block_message
+from node.blockchain.types import Type
 
 
 @pytest.mark.usefixtures('rich_blockchain')
@@ -65,14 +66,19 @@ def test_blocks_pagination(api_client):
     assert len(results) == 1
     assert results[0] == json.loads(Block.objects.get(_id=1).body)
 
-    response = api_client.get('/api/blocks/?limit=1&offset=6')
+    response = api_client.get('/api/blocks/?limit=1&offset=7')
     assert response.status_code == 200
     response_json = response.json()
     results = response_json.get('results')
     assert isinstance(results, list)
     assert len(results) == 0
 
 
+@pytest.mark.usefixtures('rich_blockchain')
+def test_list_blocks_blockchain_has_all_types():
+    assert {block.get_block().message.type for block in Block.objects.order_by('_id')} == set(Type)
+
+
 @pytest.mark.usefixtures('rich_blockchain')
 def test_retrieve_block(api_client):
     response = api_client.get('/api/blocks/0/')

node/blockchain/tests/test_rest_api/test_node.py

@@ -1,12 +1,6 @@
 import pytest
 
 
-@pytest.mark.usefixtures('base_blockchain')
-def test_list_nodes_smoke(api_client):
-    response = api_client.get('/api/nodes/')
-    assert response.status_code == 200
-
-
 @pytest.mark.usefixtures('base_blockchain')
 def test_list_nodes(primary_validator_node, api_client):
     response = api_client.get('/api/nodes/')