Converted "Game" variables and classes to "Contest"

erik-sn · erik-sn · commit ba7210e6e2be · 2017-04-26T19:46:56.000-04:00
To keep consistency between API &amp; axelrod these base classes have been
renamed to "Contest".
diff --git a/api/config/settings.py b/api/config/settings.py
@@ -1,13 +1,8 @@
 import os
-import sys
 import dj_database_url
 
-# handle case where we are testing with no .env file
-if 'test' in sys.argv or 'test_coverage' in sys.argv:
-    SECRET_KEY = 'l#-9)38*k9h9yfkcxwii++_m@3jkm%vojnjl^gkzyzmcfr_afo'
-else:
-    SECRET_KEY = os.environ['SECRET_KEY']
-
+# Environment specific settings from environment variables or local .env file
+SECRET_KEY = os.environ['SECRET_KEY']
 DEBUG = bool(os.environ.get('DEBUG', False))
 DOCKER = bool(os.environ.get('DOCKER_HOST', False))
 
@@ -125,13 +120,9 @@ def show_debug_toolbar(request):
 STATIC_URL = '/static/'
 
 REST_FRAMEWORK = {
-    'DEFAULT_PERMISSION_CLASSES': (
-        'api.config.admin.AnonymousExceptDelete',
-    ),
-    'DEFAULT_RENDERER_CLASSES': (
-        'rest_framework.renderers.JSONRenderer',
-        'rest_framework.renderers.BrowsableAPIRenderer',
-    ),
+    'DEFAULT_PERMISSION_CLASSES': [
+        'api.config.admin.AnonymousExceptDelete'
+    ]
 }
 
 
diff --git a/api/core/migrations/0006_remove_tournamentdefinition_name.py b/api/core/migrations/0006_remove_tournamentdefinition_name.py
@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2017-04-25 02:14
+from __future__ import unicode_literals
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0005_auto_20170424_2312'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='tournamentdefinition',
+            name='name',
+        ),
+    ]
diff --git a/api/core/models.py b/api/core/models.py
@@ -13,7 +13,7 @@
 import axelrod as axl
 
 
-class Game(Model):
+class Contest(Model):
 
     PENDING = 0
     RUNNING = 1
@@ -37,7 +37,7 @@ class Meta:
         abstract = True
 
 
-class GameDefinition(Model):
+class ContestDefinition(Model):
     created = DateTimeField(auto_now_add=True, editable=False)
     last_updated = DateTimeField(auto_now=True, editable=False)
     turns = IntegerField()
@@ -48,7 +48,7 @@ class Meta:
         abstract = True
 
 
-class Tournament(Game):
+class Tournament(Contest):
 
     definition = ForeignKey('TournamentDefinition')
 
@@ -67,13 +67,12 @@ def run(self, strategies):
         return results
 
 
-class TournamentDefinition(GameDefinition):
-    name = CharField(max_length=255)
+class TournamentDefinition(ContestDefinition):
     repetitions = IntegerField()
     with_morality = BooleanField()
 
 
-class Match(Game):
+class Match(Contest):
 
     definition = ForeignKey('MatchDefinition')
 
@@ -89,13 +88,13 @@ def run(self, strategies):
         return match
 
 
-class MatchDefinition(GameDefinition):
+class MatchDefinition(ContestDefinition):
 
     class Meta:
         managed = True
 
 
-class MoranProcess(Game):
+class MoranProcess(Contest):
 
     definition = ForeignKey('MoranDefinition')
 
@@ -113,14 +112,14 @@ def run(self, strategies):
         return mp
 
 
-class MoranDefinition(GameDefinition):
+class MoranDefinition(ContestDefinition):
     mode = CharField(max_length=2)
 
 
 class InternalStrategy(Model):
     """
     This model is used to represent strategies in an internal
-    database table. Games reference this in a ManyToMany
+    database table. Contests reference this in a ManyToMany
     to store the strategies in their player_list field. This is
     necessary to facilitate normalization of the database.
     """
diff --git a/api/core/serializers.py b/api/core/serializers.py
@@ -1,5 +1,3 @@
-import json
-
 from rest_framework import serializers
 from rest_framework.reverse import reverse
 
@@ -57,7 +55,7 @@ def validate_player_list(player_list):
 
     class Meta:
         model = models.TournamentDefinition
-        fields = ('name', 'created', 'last_updated', 'turns',
+        fields = ('created', 'last_updated', 'turns',
                   'repetitions', 'noise', 'with_morality', 'player_list')
 
 
@@ -113,9 +111,9 @@ class Meta:
         fields = ('id', 'created', 'last_updated', 'status', 'definition', 'results')
 
 
-class GameResultSerializer:
+class ContestResultSerializer:
     """
-    Serialize the result of an axelrod game into a dictionary by
+    Serialize the result of an axelrod contest into a dictionary by
     iterating over its __dict__ method.
     """
 
@@ -129,7 +127,7 @@ def __init__(self, result):
         self.data = response_object
 
 
-class MoranResultsSerializer(GameResultSerializer):
+class MoranResultsSerializer(ContestResultSerializer):
 
     handle_locally = [
         'mutation_targets',
@@ -156,7 +154,7 @@ def clean_mutation_targets(result):
         return mutation_targets
 
 
-class MatchResultsSerializer(GameResultSerializer):
+class MatchResultsSerializer(ContestResultSerializer):
 
     handle_locally = []
 
@@ -177,7 +175,7 @@ def __init__(self, result):
         self.data['scores'] = result.scores()
 
 
-class TournamentResultsSerializer(GameResultSerializer):
+class TournamentResultsSerializer(ContestResultSerializer):
 
     state_distribution_keys = [
     ]
diff --git a/api/core/tests/test_serializers.py b/api/core/tests/test_serializers.py
@@ -77,22 +77,19 @@ class TestTournamentDefinitionSerializer(TestCase):
     @classmethod
     def setUpClass(cls):
         cls.valid_post_data = {
-            'name': 'test_tournament',
             'turns': 5,
             'repetitions': 2,
             'noise': 0.1,
             'with_morality': False,
             'player_list': ['test1', 'test2']
         }
-        cls.missing_name = {
+        cls.missing_noise = {
             'turns': 5,
             'repetitions': 2,
-            'noise': 0.1,
             'with_morality': False,
             'player_list': ['test1', 'test2']
         }
         cls.invalid_field_values = {
-            'name': 'test_tournament',
             'turns': 5,
             'repetitions': 2,
             'noise': 0.1,
@@ -111,9 +108,9 @@ def test_is_valid_with_all_fields(self):
         self.assertTrue(serializer.is_valid())
 
     def test_is_invalid_with_missing_fields(self):
-        serializer = TournamentDefinitionSerializer(data=self.missing_name)
+        serializer = TournamentDefinitionSerializer(data=self.missing_noise)
         self.assertFalse(serializer.is_valid())
-        self.assertEqual({'name': ['This field is required.']}, serializer.errors)
+        self.assertEqual({'noise': ['This field is required.']}, serializer.errors)
 
     def test_is_invalid_with_incorrect_value(self):
         serializer = TournamentDefinitionSerializer(data=self.invalid_field_values)
diff --git a/api/core/tests/test_views.py b/api/core/tests/test_views.py
@@ -20,12 +20,6 @@ def init_params(self):
         return {}
 
 
-class TestGame(object):
-
-    def __init__(self):
-        pass
-
-
 class TestStrategyView(TestCase):
     strategies = [
         TestStrategy('Test One', {'stochastic': True, 'memory_depth': 1}),
@@ -65,30 +59,26 @@ def setUpClass(cls):
         cls.tournament1 = Tournament(id=3)
         cls.valid_post_data = {
             'id': 10,
-            'name': 'tournament',
             'turns': 5,
             'repetitions': 2,
             'noise': 0.1,
             'with_morality': False,
             'player_list': ["adaptive", "allcoralld", "adaptive", "anticycler"],
         }
         cls.no_strategy_found = {
-            'name': 'tournament',
             'turns': 5,
             'repetitions': 2,
             'noise': 0.1,
             'with_morality': False,
             'player_list': ["adapt", "allcoralld"],
         }
-        cls.missing_name = {
+        cls.missing_noise = {
             'turns': 5,
             'repetitions': 2,
-            'noise': 0.1,
             'with_morality': False,
             'player_list': ["adaptive", "allcoralld", "adaptive", "anticycler"],
         }
         cls.one_strategy = {
-            'name': 'tournament',
             'turns': 5,
             'repetitions': 2,
             'noise': 0.1,
@@ -123,10 +113,10 @@ def test_strategy_not_found(self):
 
     def test_invalid_field(self):
         response = self.client.post('/tournaments/',
-                                    json.dumps(self.missing_name),
+                                    json.dumps(self.missing_noise),
                                     content_type='application/json')
         self.assertEqual(400, response.status_code)
-        self.assertEqual({'name': ['This field is required.']}, response.data)
+        self.assertEqual({'noise': ['This field is required.']}, response.data)
 
     def test_invalid_strategy_count(self):
         response = self.client.post('/tournaments/',
diff --git a/api/core/views.py b/api/core/views.py
diff --git a/manage.py b/manage.py
