GitLabを用いた継続的インテグレーション

リスト2：リスト2：Djangoのインストール

$ pip install django

リスト3：リスト3：Djangoのsampleappプロジェクトの作成

$ mkdir server
$ cd server
$ django-admin startproject sampleapp

リスト4：リスト4：動作確認用にsampleappプロジェクトを起動させる

$ cd sampleapp
$ python manage.py runserver
Performing system checks...

System check identified no issues (0 silenced).

You have 15 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.

February 03, 2019 - 10:37:26
Django version 2.1.5, using settings 'sampleapp.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

リスト5：リスト5：RESTアプリケーションをDjangoのsampleappプロジェクトへ追加する

$ cd sampleapp
$ python manage.py startapp rest

リスト6：リスト6：INSTALLED_APPSの修正（server/sampleapp/sampleapp/settings.pyから抜粋）

ALLOWED_HOSTS = ["*"]

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework', # Django REST framework
    'rest', # restアプリケーションの追加
]

リスト7：リスト7：言語設定の変更（server/sampleapp/sampleapp/settings.pyから抜粋）

LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

リスト8：リスト8：RESTアプリケーションへのルーティングの追加（server/sampleapp/sampleapp/urls.py）

from django.contrib import admin
from django.urls import path
from django.urls import include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('rest.urls')), # RESTアプリケーションを参照するよう指定
]

リスト9：リスト9：server/sampleapp/rest/urls.py

from django.urls import path

urlpatterns = []

リスト10：リスト10：PingPong APIレスポンスボディの仕様

{
    "message": "pong"
}

リスト11：リスト11：実装用のフィーチャブランチの準備

$ git checkout -b feature/ping-pong-api

リスト12：リスト12：server/sampleapp/rest/tests/test_ping.py^※2

from django.urls import reverse
from django.test import TestCase
from rest_framework import status
from rest_framework.test import APIClient

class TestPing(TestCase):
    def test_ping_view(self):
        """
        ping-pong APIにリクエストを投げた際に、
        HTTPステータスコードとして200 OK、
        レスポンスボディとして以下のようなJSONを期待する。
        {
            "message": "pong"
        }
        """
        client = APIClient()

        path = reverse('pingpong') # pingpongという名前のついたURLを逆引きする
        response = client.get(path)

        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(response.data.get('message'), "pong")

リスト13：リスト13： 実装が存在しないために失敗しているテスト

$ python manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
E
======================================================================
ERROR: test_ping_view (rest.tests.test_ping.TestPing)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/fujiwara/repositories/ti_rancher_k8s_sampleapp/server/sampleapp/rest/tests/test_ping.py", line 18, in test_ping_view
    path = reverse('pingpong')
  File "/home/fujiwara/repositories/ti_rancher_k8s_sampleapp/sample/lib/python3.6/site-packages/django/urls/base.py", line 90, in reverse
    return iri_to_uri(resolver._reverse_with_prefix(view, prefix, *args, **kwargs))
  File "/home/fujiwara/repositories/ti_rancher_k8s_sampleapp/sample/lib/python3.6/site-packages/django/urls/resolvers.py", line 622, in _reverse_with_prefix
    raise NoReverseMatch(msg)
django.urls.exceptions.NoReverseMatch: Reverse for 'pingpong' not found. 'pingpong' is not a valid view function or pattern name.

----------------------------------------------------------------------
Ran 1 test in 0.002s

FAILED (errors=1)
Destroying test database for alias 'default'...

リスト14：リスト10：PingPong APIレスポンスボディの仕様（再掲）

{
    "message": "pong"
}

リスト15：リスト14：server/sampleapp/rest/serializers/ping_serializer.py

from rest_framework import serializers

class PingSerializer(serializers.Serializer):
    message = serializers.CharField(default='pong')

リスト16：リスト15：server/sampleapp/rest/views/ping_view.py

from rest_framework.views import APIView
from rest_framework.response import Response

from rest.serializers.ping_serializer import PingSerializer

class PingView(APIView):
    """
    GETリクエストに対してpongの文言をボディに含んだ
    HTTPレスポンスメッセージを返すAPIです。
    """

    def get(self, request, format=None):
        message = {
            "message": "pong",
        }
        serializer = PingSerializer(message)
        return Response(serializer.data)

リスト17：リスト16：server/sampleapp/rest/urls.py

from django.urls import path
from django.contrib import admin

from rest.views.ping_view import PingView

urlpatterns = [
    #/api/pingに来たリクエストをPingViewに流す
    path('ping', PingView.as_view(), name="pingpong"),
]

リスト18：リスト17：テストの実行結果

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

OK
Destroying test database for alias 'default'...