APIを自動テストする

$ git clone https://github.com/yheihei/base_diary.git
$ cd base_diary

# テストコードがすでに書いてあるブランチを見たい場合はこちら
$ git fetch && git checkout feature/#5

$ curl -X GET http://127.0.0.1:8000/api/posts/ -H 'Authorization: Token 18c26d59a34efb80ee100d55642aa644b1dc9a52'

[
	{
		"id": 1,
		"user": {
			"id": 1,
			"username": "yhei",
			"email": "yheihei0126@gmail.com"
		},
		"title": "一つ目の日記",
		"body": "最初の日記だよ",
		"created_at": "2021-07-13T05:10:40.097732Z",
		"updated_at": "2021-07-24T05:31:37.578064Z",
		"categories": [
			{
				"name": "日記",
				"slug": "diary"
			}
		]
	},
	{
		"id": 2,
		"user": {
			"id": 1,
			"username": "yhei",
			"email": "yheihei0126@gmail.com"
		},
		"title": "二つ目の日記",
		"body": "この日記は2つ目の日記だよ",
		"created_at": "2021-07-04T05:11:13.196329Z",
		"updated_at": "2021-07-22T13:59:50.294969Z",
		"categories": [
			{
				"name": "雑記",
				"slug": "general"
			}
		]
	}
]

$ pip install djangorestframework
$ pip install django-filter

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken',  #rest_frameworkにトークン認証の機能をつける
    'django_filters',
]

...

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend'],
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',
    ),
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',
        'rest_framework.authentication.SessionAuthentication',
    )
}

from django.db.models import fields
from diary.models import Post, Category, User
from rest_framework import serializers


class UserSerializer(serializers.ModelSerializer):
  class Meta:
    model = User
    fields = ('id', 'username', 'email')


class CategorySerializer(serializers.ModelSerializer):
  class Meta:
    model = Category
    fields = ('name', 'slug')


class PostSerializer(serializers.ModelSerializer):
  user = UserSerializer(read_only=True)
  categories = CategorySerializer(many=True, read_only=True)

  class Meta:
    model = Post
    fields = ('id', 'user', 'title', 'body', 'created_at', 'updated_at', 'categories')

[
	{
		"id": 1,
		"user": {
			"id": 1,
			"username": "yhei",
			"email": "yheihei0126@gmail.com"
		},
		"title": "一つ目の日記",
		"body": "最初の日記だよ",
		"created_at": "2021-07-13T05:10:40.097732Z",
		"updated_at": "2021-07-24T05:31:37.578064Z",
		"categories": [
			{
				"name": "日記",
				"slug": "diary"
			}
		]
	},
...
...

from django.shortcuts import render

# Create your views here.
from .models import Post, User
from rest_framework import viewsets, filters
from .serializers import PostSerializer
from rest_framework.authentication import TokenAuthentication, SessionAuthentication, BasicAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.decorators import permission_classes, authentication_classes

# Create your views here.
def index(request):
  return render(request, 'index.html', {
    'posts': Post.objects.all(),
  })


class CategoryFilter(filters.BaseFilterBackend):
  def filter_queryset(self, request, queryset, view):
    if request.query_params.get('category'):
      return queryset.filter(categories__slug=request.query_params.get('category'))
    return queryset


class PostViewSet(viewsets.ModelViewSet):
  queryset = Post.objects.all()
  serializer_class = PostSerializer
  filter_backends = [
    filters.SearchFilter,
    filters.OrderingFilter,
    CategoryFilter,
  ]
  search_fields = ('title', 'body')
  ordering_fields = ('created_at', 'updated_at')

  def perform_create(self, serializer):
    serializer.save(user=self.request.user)

serializer_class = PostSerializer

class PostViewSet(viewsets.ModelViewSet):
  queryset = Post.objects.all()
  serializer_class = PostSerializer

from django.urls import path
from django.conf.urls import url, include
from . import views
from rest_framework import routers
from rest_framework.authtoken import views as auth_views

app_name = "diary"

router = routers.DefaultRouter()
router.register(r'posts', views.PostViewSet)

urlpatterns = [
  path("", views.index, name="index"),
  url(r'^api/', include(router.urls)),
  url(r'^api-token-auth/', auth_views.obtain_auth_token),
]

$ python manage.py migrate
$ python manage.py runserver

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend'],
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',  # 全API認証必須
    ),
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',  # トークン認証
        'rest_framework.authentication.SessionAuthentication',  # ログインでの認証
    )
}

$ curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"username":"yhei","password":"password"}' http://127.0.0.1:8000/api-token-auth/

{"token":"7e033a902ac180e0231fced74ba58fcd658c7bbf"}

$ curl -X GET http://127.0.0.1:8000/api/posts/ -H 'Authorization: Token 7e033a902ac180e0231fced74ba58fcd658c7bbf'
[{"id":1,"user":{"id":1,"username":"yhei","email":"yheihei0126@gmail.com"},"title":"一つ目の日記","body":"最初の日記だよ","created_at":"2021-07-13T05:10:40.097732Z","updated_at":"2021-07-24T05:31:37.578064Z","categories":[{"name":"日記","slug":"diary"}]},{"id":2,"user":{"id":1,"username":"yhei","email":"yheihei0126@gmail.com"},"title":"二つ目の日記","body":"この日記は2つ目の日記だよ","created_at":"2021-07-04T05:11:13.196329Z","updated_at":"2021-07-22T13:59:50.294969Z","categories":[{"name":"雑記","slug":"general"}]},{"id":3,"user":{"id":1,"username":"yhei","email":"yheihei0126@gmail.com"},"title":"title","body":"パッチで更新してみた","created_at":"2021-07-22T15:51:34.655604Z","updated_at":"2021-07-22T17:33:10.124466Z","categories":[]}]

[
  {
      "model": "diary.user",
      "pk": 1,
      "fields": {
          "password": "pbkdf2_sha256$180000$vYCnAMtlYpZj$GlAfVlJZP6X4qTF2mcRKYHnBKOr5cFmWVdE1HVLZJOc=",
          "last_login": "2021-07-13T05:09:45.196Z",
          "is_superuser": true,
          "username": "yhei",
          "first_name": "",
          "last_name": "",
          "email": "yheihei0126@gmail.com",
          "is_staff": true,
          "is_active": true,
          "date_joined": "2021-07-13T05:09:21.149Z",
          "groups": [],
          "user_permissions": []
      }
  },
  {
      "model": "authtoken.token",
      "pk": "7e033a902ac180e0231fced74ba58fcd658c7bbf",
      "fields": {
          "user": 1,
          "created": "2021-07-30T00:00:27.143Z"
      }
  },
  {
      "model": "diary.post",
      "pk": 1,
      "fields": {
          "user": 1,
          "title": "1つめの日記",
          "body": "1つめの日記本文",
          "created_at": "2021-07-03T05:10:40.097Z",
          "updated_at": "2021-07-22T14:22:57.007Z",
          "categories": [
              1
          ]
      }
  },
  {
      "model": "diary.post",
      "pk": 2,
      "fields": {
          "user": 1,
          "title": "2つめの日記",
          "body": "2つめの日記本文",
          "created_at": "2021-07-04T05:11:13.196Z",
          "updated_at": "2021-07-22T13:59:50.294Z",
          "categories": [
              2
          ]
      }
  },
  {
      "model": "diary.category",
      "pk": 1,
      "fields": {
          "name": "日記",
          "slug": "diary",
          "created_at": "2021-07-22T13:59:23.525Z",
          "updated_at": "2021-07-22T13:59:23.525Z"
      }
  },
  {
      "model": "diary.category",
      "pk": 2,
      "fields": {
          "name": "雑記",
          "slug": "general",
          "created_at": "2021-07-22T13:59:39.153Z",
          "updated_at": "2021-07-22T13:59:39.153Z"
      }
  }
]

  {
      "model": "authtoken.token",
      "pk": "7e033a902ac180e0231fced74ba58fcd658c7bbf",
      "fields": {
          "user": 1,
          "created": "2021-07-30T00:00:27.143Z"
      }
  },

from django.test import TestCase, Client
from diary.models import User, Post
from django.urls import reverse

# Create your tests here.
class TestApiPosts(TestCase):
  '''投稿のAPIテスト'''
  # 1. fixtureを読み込む
  fixtures = ['diary/fixtures/test/test_api_posts.json']

  def test_1(self):
    '''投稿一覧が取得できるか'''
    client = Client()
    response = client.get(
      # 2. urlを指定
      '/api/posts/',
      # 3. ヘッダに認証トークンを付与する
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )
    self.assertEqual(200, response.status_code)

$ python manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
.
----------------------------------------------------------------------
Ran 1 test in 0.034s

OK

from django.test import TestCase, Client
from diary.models import User, Post
from django.urls import reverse

# Create your tests here.
class TestApiPosts(TestCase):
  '''投稿のAPIテスト'''
  # 1. fixtureを読み込む
  fixtures = ['diary/fixtures/test/test_api_posts.json']

  def test_1(self):
    '''投稿一覧が取得できるか'''
    client = Client()
    # 2. ユーザーIDが1のユーザーでログインする
    client.force_login(User.objects.get(id=1))
    response = client.get(
      # 3. urlを指定
      '/api/posts/',
    )
    self.assertEqual(200, response.status_code)

$ python manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
.
----------------------------------------------------------------------
Ran 1 test in 0.034s

OK

  def test_1(self):
    '''投稿一覧が取得できるか'''
    client = Client()
    response = client.get(
      '/api/posts/',
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )
    self.assertEqual(200, response.status_code)
    self.assertEqual(
      [
        {
          "id": 1,
          "user": {
            "id": 1,
            "username": "yhei",
            "email": "yheihei0126@gmail.com"
          },
          "title": "1つめの日記",
          "body": "1つめの日記本文",
          "created_at": "2021-07-03T05:10:40.097000Z",
          "updated_at": "2021-07-22T14:22:57.007000Z",
          "categories": [
            {
              "name": "日記",
              "slug": "diary"
            }
          ]
        },
        {
          "id": 2,
          "user": {
            "id": 1,
            "username": "yhei",
            "email": "yheihei0126@gmail.com"
          },
          "title": "2つめの日記",
          "body": "2つめの日記本文",
          "created_at": "2021-07-04T05:11:13.196000Z",
          "updated_at": "2021-07-22T13:59:50.294000Z",
          "categories": [
            {
              "name": "雑記",
              "slug": "general"
            }
          ]
        },
      ],
      response.json()
    )

self.assertEqual(期待値, response.json())

  def test_2(self):
    '''カテゴリで検索できるか'''
    client = Client()
    response = client.get(
      '/api/posts/',
      {
        'category': 'diary',
      },
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )
    self.assertEqual(200, response.status_code)
    self.assertEqual(
      [
        {
          "id": 1,
          "user": {
            "id": 1,
            "username": "yhei",
            "email": "yheihei0126@gmail.com"
          },
          "title": "1つめの日記",
          "body": "1つめの日記本文",
          "created_at": "2021-07-03T05:10:40.097000Z",
          "updated_at": "2021-07-22T14:22:57.007000Z",
          "categories": [
            {
              "name": "日記",
              "slug": "diary"
            }
          ]
        },
      ],
      response.json()
    )

    response = client.get(
      '/api/posts/',  # URL指定
      {
        'category': 'diary',  # ?category=diary のクエリを追加
      },
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )

    self.assertEqual(
      [
        {
          "id": 1,
          "user": {
            "id": 1,
            "username": "yhei",
            "email": "yheihei0126@gmail.com"
          },
          "title": "1つめの日記",
          "body": "1つめの日記本文",
          "created_at": "2021-07-03T05:10:40.097000Z",
          "updated_at": "2021-07-22T14:22:57.007000Z",
          "categories": [
            {
              "name": "日記",
              "slug": "diary"
            }
          ]
        },
      ],
      response.json()
    )

$ python manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
..
----------------------------------------------------------------------
Ran 2 tests in 0.044s

OK

  def test_5(self):
    '''新規投稿できるか'''
    client = Client()
    # 1. postメソッドでPOSTできる
    response = client.post(
      '/api/posts/',
      # 2. 第二引数に辞書型を入れると、リクエストボディーに指定する値が定義される
      {
        'title': 'title for test_6',
        'body': 'body for test_6',
      },
      content_type='application/json',
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )
    self.assertEqual(201, response.status_code)
    post = Post.objects.get(title='title for test_6')
    self.assertEqual('body for test_6', post.body)
    self.assertEqual(User.objects.first(), post.user)

    response = client.get(
      '/api/posts/',
      # ヘッダに認証トークンを付与する
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )

    # ユーザーIDが1のユーザーでログインする
    client.force_login(User.objects.get(id=1))
    response = client.get(
      # urlを指定
      '/api/posts/',
    )

    response = client.get(
      '/api/posts/',
      {
        'category': 'diary',
      },
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )

    response = client.post(
      '/api/posts/',
      {
        'title': 'title for test_6',
        'body': 'body for test_6',
      },
      content_type='application/json',
      HTTP_AUTHORIZATION=f"Token 7e033a902ac180e0231fced74ba58fcd658c7bbf"
    )