Merge pull request #9 from alphagov/add-job

Added model and dao for Jobs.

app/dao/jobs_dao.py

@@ -0,0 +1,19 @@
+from app import db
+from app.models import Job
+
+
+def save_job(job):
+    db.session.add(job)
+    db.session.commit()
+
+
+def get_job_by_id(id):
+    return Job.query.get(id)
+
+
+def get_jobs_by_service(service_id):
+    return Job.query.filter_by(service_id=service_id).all()
+
+
+def get_jobs():
+    return Job.query.all()

app/models.py

@@ -1,6 +1,8 @@
 from . import db
 import datetime
 
+from sqlalchemy.dialects.postgresql import UUID
+
 
 def filter_null_value_fields(obj):
     return dict(
@@ -95,3 +97,26 @@ class Template(db.Model):
     content = db.Column(db.Text, index=False, unique=False, nullable=False)
     service_id = db.Column(db.BigInteger, db.ForeignKey('services.id'), index=True, unique=False)
     service = db.relationship('Service', backref=db.backref('templates', lazy='dynamic'))
+
+
+class Job(db.Model):
+
+    __tablename__ = 'jobs'
+
+    id = db.Column(UUID(as_uuid=True), primary_key=True)
+    original_file_name = db.Column(db.String, nullable=False)
+    service_id = db.Column(db.BigInteger, db.ForeignKey('services.id'), index=True, unique=False)
+    service = db.relationship('Service', backref=db.backref('jobs', lazy='dynamic'))
+    template_id = db.Column(db.BigInteger, db.ForeignKey('templates.id'), index=True, unique=False)
+    created_at = db.Column(
+        db.DateTime,
+        index=False,
+        unique=False,
+        nullable=False,
+        default=datetime.datetime.now)
+    updated_at = db.Column(
+        db.DateTime,
+        index=False,
+        unique=False,
+        nullable=True,
+        onupdate=datetime.datetime.now)

app/schemas.py

@@ -19,7 +19,7 @@ class UserSchema(ma.ModelSchema):
 class ServiceSchema(ma.ModelSchema):
     class Meta:
         model = models.Service
-        exclude = ("updated_at", "created_at", "tokens", "templates")
+        exclude = ("updated_at", "created_at", "tokens", "templates", "jobs")
 
 
 class TemplateSchema(ma.ModelSchema):

migrations/versions/0004_create_jobs.py

@@ -0,0 +1,40 @@
+"""empty message
+
+Revision ID: 0004_create_jobs
+Revises: 0003_create_tokens
+Create Date: 2016-01-15 10:12:02.381160
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '0004_create_jobs'
+down_revision = '0003_create_tokens'
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('jobs',
+    sa.Column('id', postgresql.UUID(as_uuid=True), nullable=False),
+    sa.Column('original_file_name', sa.String(), nullable=False),
+    sa.Column('service_id', sa.BigInteger(), nullable=True),
+    sa.Column('template_id', sa.BigInteger(), nullable=True),
+    sa.Column('created_at', sa.DateTime(), nullable=False),
+    sa.Column('updated_at', sa.DateTime(), nullable=True),
+    sa.ForeignKeyConstraint(['service_id'], ['services.id'], ),
+    sa.ForeignKeyConstraint(['template_id'], ['templates.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_jobs_service_id'), 'jobs', ['service_id'], unique=False)
+    op.create_index(op.f('ix_jobs_template_id'), 'jobs', ['template_id'], unique=False)
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_jobs_template_id'), table_name='jobs')
+    op.drop_index(op.f('ix_jobs_service_id'), table_name='jobs')
+    op.drop_table('jobs')
+    ### end Alembic commands ###

tests/app/conftest.py

@@ -1,9 +1,11 @@
 import pytest
-from app.models import (User, Service, Template, Token)
+from app.models import (User, Service, Template, Token, Job)
 from app.dao.users_dao import (save_model_user)
 from app.dao.services_dao import save_model_service
 from app.dao.templates_dao import save_model_template
 from app.dao.tokens_dao import save_model_token
+from app.dao.jobs_dao import save_job
+import uuid
 
 
 @pytest.fixture(scope='function')
@@ -57,10 +59,30 @@ def sample_template(notify_db,
 def sample_token(notify_db,
                  notify_db_session,
                  service=None):
-    import uuid
     if service is None:
         service = sample_service(notify_db, notify_db_session)
     data = {'service_id': service.id}
     token = Token(**data)
     save_model_token(token)
     return token
+
+
+@pytest.fixture(scope='function')
+def sample_job(notify_db,
+               notify_db_session,
+               service=None,
+               template=None):
+    if service is None:
+        service = sample_service(notify_db, notify_db_session)
+    if template is None:
+        template = sample_template(notify_db, notify_db_session,
+                                   service=service)
+    data = {
+        'id': uuid.uuid4(),
+        'service_id': service.id,
+        'template_id': template.id,
+        'original_file_name': 'some.csv'
+    }
+    job = Job(**data)
+    save_job(job)
+    return job

tests/app/dao/test_jobs_dao.py

@@ -0,0 +1,66 @@
+import uuid
+
+from app.dao.jobs_dao import (
+    save_job,
+    get_job_by_id,
+    get_jobs_by_service,
+    get_jobs
+)
+
+from app.models import Job
+
+
+def test_save_job(notify_db, notify_db_session, sample_template):
+
+    assert Job.query.count() == 0
+    job_id = uuid.uuid4()
+    data = {
+        'id': job_id,
+        'service_id': sample_template.service_id,
+        'template_id': sample_template.id,
+        'original_file_name': 'some.csv'
+    }
+
+    job = Job(**data)
+    save_job(job)
+
+    assert Job.query.count() == 1
+    job_from_db = Job.query.get(job_id)
+    assert job == job_from_db
+
+
+def test_get_job_by_id(notify_db, notify_db_session, sample_template):
+    assert Job.query.count() == 0
+    job_id = uuid.uuid4()
+    data = {
+        'id': job_id,
+        'service_id': sample_template.service_id,
+        'template_id': sample_template.id,
+        'original_file_name': 'some.csv'
+    }
+    job = Job(**data)
+    save_job(job)
+
+    job_from_db = get_job_by_id(job_id)
+
+    assert job == job_from_db
+
+
+def test_get_jobs_for_service(notify_db, notify_db_session, sample_job):
+
+    service_id = sample_job.service_id
+    job_from_db = get_jobs_by_service(service_id)
+
+    assert len(job_from_db) == 1
+    assert sample_job == job_from_db[0]
+
+
+def test_get_all_jobs(notify_db, notify_db_session, sample_template):
+    from tests.app.conftest import sample_job as create_job
+    for i in range(5):
+        create_job(notify_db,
+                   notify_db_session,
+                   sample_template.service,
+                   sample_template)
+    jobs_from_db = get_jobs()
+    assert len(jobs_from_db) == 5