Differential D999

Resultsdb - API v2.0 implementation
ClosedPublic
Actions

Authored by jskladan on Sep 13 2016, 2:19 PM.

Details

Reviewers
tflink
Group Reviewers
libtaskotron
Commits
rRSDBb56bc5b3995a: Resultsdb - API v2.0 implementation
rRSDB06c47f859196: Modified API v1.0 to work with new database
rRSDBe7c0c016686b: Api v2.0 - PEP8
rRSDB1b1f4b5a70b6: Changes made during resultsdb_api development
rRSDB273dc969a59e: Added tests for API v2.0
rRSDB175cb3101410: Initial v2.0 implementation
rRSDB3ac110fb057a: Get multiple groups by uuid, tests
rRSDB27ea44751994: .
rRSDB913c99651e69: Added arclint
rRSDB679d5273e0ce: API v.20 - changes after initial testing
rRSDB8c0df7fd4686: PEP8
rRSDB865087cda36c: Changed schema to v 2.0
rRSDB62c49f7fac88: Resultsdb - API v2.0 implementation
rRSDB936a472232de: Linter
Summary

Changes since 1.0

  • Removed Jobs and replaced with Groups to remove the "execution status" (originaly represented by Job) from ResultsDB, but keeping the ability to group Results, as it might make semantical sense
    • Result can be a part of 0-n Groups
    • UUID as a default Group identifier instead of id
  • In the response data: *href (pointer to self) is only present in the resource's data, not in the general queries that return collections, since the 'search' queries' href was not permalink
    • ref_url as a common "external url" attribute
      • Result.ref_url instead of Result.log_url
      • Testcase.ref_url instead of Testcase.url
  • Changes in the Group object
    • results is an URL at which Results in that particular Group can be
    • name renamed to description
  • Changes in the Result object
    • ref_url instead of log_url
    • result_data replaced with data
    • summary replaced with note
    • only PASSED, FAILED, INFO, NEEDS_INSPECTION are now valid outcome values
    • groups is a list of Group urls which the Result is part of
    • When submitting new Result, Testcase and Group \[resource\] can be represented either by the unique identifier \[uid\] (Testcase.name, Group.uuid), or by object containing the uid, and any other applicable resource's attributes
      • resource is identified by uid and:
        • exists -> resource is linked to the Result
        • does _not_ exist -> resource is created. Other attributes are set to default values
      • resource is identified by object and:
        • exists -> relevant attributes of the resource are updated to the provided values
        • does _not_ exist -> resource is created, relevant attributes are set to the provided values
  • Changes in the Testcase object
    • ref_url instead of url
  • Changes in querying:
    • * (star) used as a wildcard instead of % (percent sign) in the like: filters
    • Result
      • added testcases keyword to filter by Testcase.name
        • like filter allowed
        • multiple values can be provided, separate by commas to get or filter based on all the values provided: ...&testcases=name1,name2
    • Group
      • like filter for description
  • _auth placeholder for the Authorization/Authenticaion data in the Request queries; Ignored at the moment

API documentation is here: http://docs.resultsdb20.apiary.io/#

Test Plan

Unittests are present, and working

Diff Detail

Repository
rRSDB resultsdb
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
jskladan retitled this revision from to Resultsdb - API v2.0 implementation.Sep 13 2016, 2:19 PM
jskladan updated this object.
jskladan edited the test plan for this revision. (Show Details)
jskladan added a reviewer: libtaskotron.
tflink accepted this revision.Sep 13 2016, 10:27 PM
tflink added a reviewer: tflink.

Found some piddly little stuff but overall, looks good to me. I assume that you've been running it locally enough to be confident that it'll work well enough for dev when it lands.

Does this include db optimizations from the conversations during Flock?

migration.sh
2

was this supposed to be part of the revision?

resultsdb/__init__.py
34

Shouldn't this version be bumped with such a major change?

resultsdb/controllers/api_v1.py
47–48

s/fot/for

resultsdb/controllers/api_v2.py
261

If this is all commented out, can it be removed?

495

Is this documented anywhere?

702

Same question as above - if this is commented out, can it be removed entirely?

resultsdb/proxy.py
6

This comment needs to be updated

This revision is now accepted and ready to land.Sep 13 2016, 10:27 PM
tflink added subscribers: • ralph2, kparal.Sep 13 2016, 10:35 PM

adding @kparal and @ralph2 as a subscribers in case they're interested in looking at the changes before they land

jskladan added a comment.Sep 14 2016, 9:41 AM

Thanks for the comments, I'll go and do it ASAP.

migration.sh
2

oops, missed this one bugger, thanks!

resultsdb/__init__.py
34

Absolutely, I just though we'd bump it before release, together with specfile.
But I can absolutely do it in the revision, too.

resultsdb/controllers/api_v2.py
261

Sure thing, /me just missed it.

495

The fact, and reasoning is stated in the docs: http://docs.resultsdb20.apiary.io/#reference/0/results/create-new-result (see the data section), but if you can think of a better place, I'm all for it.

702

Sure, /me just forgot to do it.

resultsdb/proxy.py
6

Will, do. I did not really touch the file apart of the autopep8 :)

Closed by commit rRSDB62c49f7fac88: Resultsdb - API v2.0 implementation (authored by Josef Skladanka <jskladan@redhat.com>). · Explain WhyOct 4 2016, 10:55 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 2606

View Options

.arclint

  • This file was added.
1​{
2​ "linters": {
3​ "flake8": {
4​ "type": "flake8",
5​ "include": "(\\.py$)",
6​ "severity.rules": {
7​ "(E501)": "disabled",
8​ "(^E)": "warning",
9​ "(^F)": "error"
10​ }
11​ }
12​ }
13​}
View Options

.gitignore

1*.pyc 1​*.pyc
2*.pyo 2​*.pyo
3*.swp 3​*.swp
4*__pycache__* 4​*__pycache__*
5.ropeproject/ 5​.ropeproject/
6conf/settings.py 6​conf/settings.py
7*.sqlite 7​*.sqlite
8*.sass-cache 8​*.sass-cache
9*build/ 9​*build/
10*dist/ 10​*dist/
11*.egg* 11​*.egg*
12/env*/ 12​/env*/
13.coverage 13​.coverage
14htmlcov/ 14​htmlcov/
15​.cache
View Options

alembic/env.py

Show All 20 Lines
21target_metadata = db.metadata 21​target_metadata = db.metadata
22#target_metadata = None 22​#target_metadata = None
23 23​
24# other values from the config, defined by the needs of env.py, 24​# other values from the config, defined by the needs of env.py,
25# can be acquired: 25​# can be acquired:
26# my_important_option = config.get_main_option("my_important_option") 26​# my_important_option = config.get_main_option("my_important_option")
27# ... etc. 27​# ... etc.
28 28​
29​
29def run_migrations_offline(): 30​def run_migrations_offline():
30 """Run migrations in 'offline' mode. 31​ """Run migrations in 'offline' mode.
31 32​
32 This configures the context with just a URL 33​ This configures the context with just a URL
33 and not an Engine, though an Engine is acceptable 34​ and not an Engine, though an Engine is acceptable
34 here as well. By skipping the Engine creation 35​ here as well. By skipping the Engine creation
35 we don't even need a DBAPI to be available. 36​ we don't even need a DBAPI to be available.
36 37​
37 Calls to context.execute() here emit the given string to the 38​ Calls to context.execute() here emit the given string to the
38 script output. 39​ script output.
39 40​
40 """ 41​ """
41 url = config.get_main_option("sqlalchemy.url") 42​ url = config.get_main_option("sqlalchemy.url")
42 context.configure(url=url, compare_type=True) 43​ context.configure(url=url, compare_type=True)
43 44​
44 with context.begin_transaction(): 45​ with context.begin_transaction():
45 context.run_migrations() 46​ context.run_migrations()
46 47​
48​
47def run_migrations_online(): 49​def run_migrations_online():
48 """Run migrations in 'online' mode. 50​ """Run migrations in 'online' mode.
49 51​
50 In this scenario we need to create an Engine 52​ In this scenario we need to create an Engine
51 and associate a connection with the context. 53​ and associate a connection with the context.
52 54​
53 """ 55​ """
54 56​
55 alembic_config = config.get_section(config.config_ini_section) 57​ alembic_config = config.get_section(config.config_ini_section)
56 from resultsdb import app 58​ from resultsdb import app
57 alembic_config['sqlalchemy.url'] = app.config['SQLALCHEMY_DATABASE_URI'] 59​ alembic_config['sqlalchemy.url'] = app.config['SQLALCHEMY_DATABASE_URI']
58 60​
59 engine = engine_from_config( 61​ engine = engine_from_config(
60 alembic_config, 62​ alembic_config,
61 prefix='sqlalchemy.', 63​ prefix='sqlalchemy.',
62 poolclass=pool.NullPool) 64​ poolclass=pool.NullPool)
63 65​
64 connection = engine.connect() 66​ connection = engine.connect()
65 context.configure( 67​ context.configure(
66 connection=connection, 68​ connection=connection,
67 target_metadata=target_metadata 69​ target_metadata=target_metadata
68 ) 70​ )
69 71​
70 try: 72​ try:
71 with context.begin_transaction(): 73​ with context.begin_transaction():
72 context.run_migrations() 74​ context.run_migrations()
73 finally: 75​ finally:
74 connection.close() 76​ connection.close()
75 77​
76if context.is_offline_mode(): 78​if context.is_offline_mode():
77 run_migrations_offline() 79​ run_migrations_offline()
78else: 80​else:
79 run_migrations_online() 81​ run_migrations_online()
80 ​
View Options

alembic/versions/433d0b5b3b96_added_index_on_the_keyval_store.py

1"""Added index on the Keyval store 1​"""Added index on the Keyval store
2 2​
3Revision ID: 433d0b5b3b96 3​Revision ID: 433d0b5b3b96
4Revises: 15f5eeb9f635 4​Revises: 15f5eeb9f635
5Create Date: 2015-02-24 19:57:57.643189 5​Create Date: 2015-02-24 19:57:57.643189
6 6​
7""" 7​"""
8 8​
9# revision identifiers, used by Alembic. 9​# revision identifiers, used by Alembic.
10revision = '433d0b5b3b96' 10​revision = '433d0b5b3b96'
11down_revision = '15f5eeb9f635' 11​down_revision = '15f5eeb9f635'
12branch_labels = None 12​branch_labels = None
13depends_on = None 13​depends_on = None
14 14​
15from alembic import op 15​from alembic import op
16import sqlalchemy as sa ​
17 16​
18 17​
19def upgrade(): 18​def upgrade():
20 ### commands auto generated by Alembic - please adjust! ### 19​ ### commands auto generated by Alembic - please adjust! ###
21 op.create_index('rd_key_value_idx', 'result_data', ['key', 'value'], unique=False, mysql_length={'value': 50, 'key': 20}) 20​ op.create_index('rd_key_value_idx', 'result_data', [
21​ 'key', 'value'], unique=False, mysql_length={'value': 50, 'key': 20})
22 ### end Alembic commands ### 22​ ### end Alembic commands ###
23 23​
24 24​
25def downgrade(): 25​def downgrade():
26 ### commands auto generated by Alembic - please adjust! ### 26​ ### commands auto generated by Alembic - please adjust! ###
27 op.drop_index('rd_key_value_idx', table_name='result_data') 27​ op.drop_index('rd_key_value_idx', table_name='result_data')
28 ### end Alembic commands ### 28​ ### end Alembic commands ###
View Options

alembic/versions/4ace44a44bf_change_index_on_result_data_so_like_can_.py

1"""Change index on result_data so LIKE can use it 1​"""Change index on result_data so LIKE can use it
2 2​
3Revision ID: 4ace44a44bf 3​Revision ID: 4ace44a44bf
4Revises: 153c416322c2 4​Revises: 153c416322c2
5Create Date: 2015-04-14 17:20:32.575195 5​Create Date: 2015-04-14 17:20:32.575195
6 6​
7""" 7​"""
8 8​
9# revision identifiers, used by Alembic. 9​# revision identifiers, used by Alembic.
10revision = '4ace44a44bf' 10​revision = '4ace44a44bf'
11down_revision = '153c416322c2' 11​down_revision = '153c416322c2'
12branch_labels = None 12​branch_labels = None
13depends_on = None 13​depends_on = None
14 14​
15from alembic import op 15​from alembic import op
16import sqlalchemy as sa ​
17 16​
18 17​
19def upgrade(): 18​def upgrade():
20 ### commands auto generated by Alembic - please adjust! ### 19​ ### commands auto generated by Alembic - please adjust! ###
21 op.create_index('result_data_idx_key_value', 'result_data', ['key', 'value'], unique=False, 20​ op.create_index('result_data_idx_key_value', 'result_data', ['key', 'value'], unique=False,
22 postgresql_ops={'value': 'text_pattern_ops', 'key': 'text_pattern_ops'}) 21​ postgresql_ops={'value': 'text_pattern_ops', 'key': 'text_pattern_ops'})
23 op.drop_index('rd_key_value_idx', table_name='result_data') 22​ op.drop_index('rd_key_value_idx', table_name='result_data')
24 ### end Alembic commands ### 23​ ### end Alembic commands ###
25 24​
26 25​
27def downgrade(): 26​def downgrade():
28 ### commands auto generated by Alembic - please adjust! ### 27​ ### commands auto generated by Alembic - please adjust! ###
29 op.create_index('rd_key_value_idx', 'result_data', ['key', 'value'], unique=False) 28​ op.create_index('rd_key_value_idx', 'result_data', ['key', 'value'], unique=False)
30 op.drop_index('result_data_idx_key_value', table_name='result_data') 29​ op.drop_index('result_data_idx_key_value', table_name='result_data')
31 ### end Alembic commands ### 30​ ### end Alembic commands ###
View Options

alembic/versions/540dbe71fa91_change_schema_to_v2_0_step_1.py

  • This file was added.
1​"""Change schema to v2.0 - step 1 - prepare columns
2​
3​Revision ID: 59bef5afc9aa
4​Revises: 978007ecd2b
5​Create Date: 2016-08-23 20:10:05.734728
6​
7​"""
8​
9​# revision identifiers, used by Alembic.
10​revision = '540dbe71fa91'
11​down_revision = '978007ecd2b'
12​branch_labels = None
13​depends_on = None
14​
15​from alembic import op
16​import sqlalchemy as sa
17​
18​
19​def upgrade():
20​ # JOB
21​ op.rename_table('job', 'group')
22​ op.alter_column('group', 'name', new_column_name='description')
23​ op.drop_column(u'group', 'status')
24​ op.drop_column(u'group', 'start_time')
25​ op.drop_column(u'group', 'end_time')
26​ op.create_unique_constraint(None, 'group', ['uuid'])
27​ op.create_index(
28​ 'group_idx_uuid', 'group', ['uuid'], unique=False, postgresql_ops={'uuid': 'text_pattern_ops'})
29​
30​ # RESULT
31​ op.add_column(u'result', sa.Column('testcase_name', sa.Text(), nullable=True))
32​ op.alter_column('result', 'summary', new_column_name='note')
33​ op.alter_column('result', 'log_url', new_column_name='ref_url')
34​ op.create_index('result_fk_testcase_name', 'result', [
35​ 'testcase_name'], unique=False, postgresql_ops={'testcase_name': 'text_pattern_ops'})
36​ op.drop_index('result_fk_job_id', table_name='result')
37​ op.drop_index('result_fk_testcase_id', table_name='result')
38​ op.drop_constraint(u'result_testcase_id_fkey', 'result', type_='foreignkey')
39​ op.drop_constraint(u'result_job_id_fkey', 'result', type_='foreignkey')
40​ op.create_foreign_key(None, 'result', 'testcase', ['testcase_name'], ['name'])
41​
42​ # TESTCASE
43​ op.alter_column('testcase', 'url', new_column_name='ref_url')
44​
45​ # MANY TO MANY
46​ op.create_table('groups_to_results',
47​ sa.Column('id', sa.Integer(), nullable=False),
48​ sa.Column('group_uuid', sa.String(36), nullable=True),
49​ sa.Column('result_id', sa.Integer(), nullable=True),
50​ sa.ForeignKeyConstraint(['group_uuid'], ['group.uuid'], ),
51​ sa.ForeignKeyConstraint(['result_id'], ['result.id'], ),
52​ sa.PrimaryKeyConstraint('id')
53​ )
54​ op.create_index('gtr_fk_group_uuid', 'groups_to_results', [
55​ 'group_uuid'], unique=False, postgresql_ops={'uuid': 'text_pattern_ops'})
56​ op.create_index('gtr_fk_result_id', 'groups_to_results', ['result_id'], unique=False)
57​
58​
59​def downgrade():
60​ # TESTCASE
61​ op.alter_column('testcase', 'ref_url', new_column_name='url')
62​
63​ # RESULT
64​ op.alter_column('result', 'note', new_column_name='summary')
65​ op.alter_column('result', 'ref_url', new_column_name='log_url')
66​ op.drop_constraint('result_testcase_name_fkey', 'result', type_='foreignkey')
67​ op.create_index('result_fk_testcase_id', 'result', ['testcase_id'], unique=False)
68​ op.create_index('result_fk_job_id', 'result', ['job_id'], unique=False)
69​ op.drop_index('result_fk_testcase_name', table_name='result')
70​ op.drop_column(u'result', 'testcase_name')
71​
72​ # JOB
73​ op.rename_table('group', 'job')
74​ op.alter_column('job', 'description', new_column_name='name')
75​ op.add_column(u'job', sa.Column('end_time', sa.DateTime(), nullable=True))
76​ op.add_column(u'job', sa.Column('start_time', sa.DateTime(), nullable=True))
77​ op.add_column(u'job', sa.Column('status', sa.VARCHAR(length=16), nullable=True))
78​ op.drop_index('group_idx_uuid', table_name='job')
79​
80​ # MANY TO MANY
81​ op.drop_index('gtr_fk_result_id', table_name='groups_to_results')
82​ op.drop_index('gtr_fk_group_uuid', table_name='groups_to_results')
83​ op.drop_table('groups_to_results')
84​
85​ # CONSTRAINTS
86​ op.create_foreign_key(None, 'result', 'job', ['job_id'], ['id'])
87​ op.create_foreign_key(None, 'result', 'testcase', ['testcase_id'], ['id'])
88​ op.drop_constraint('group_uuid_key', 'job')
View Options

alembic/versions/978007ecd2b_changed_testcase_name_to_text.py

Show All 13 Lines
14 14​
15from alembic import op 15​from alembic import op
16import sqlalchemy as sa 16​import sqlalchemy as sa
17 17​
18 18​
19def upgrade(): 19​def upgrade():
20 ### commands auto generated by Alembic - please adjust! ### 20​ ### commands auto generated by Alembic - please adjust! ###
21 op.alter_column('testcase', 'name', type_=sa.Text) 21​ op.alter_column('testcase', 'name', type_=sa.Text)
22 op.create_index('testcase_idx_name', 'testcase', ['name'], unique=False, postgresql_ops={'name': 'text_pattern_ops'}) 22​ op.create_index('testcase_idx_name', 'testcase', [
23​ 'name'], unique=False, postgresql_ops={'name': 'text_pattern_ops'})
23 ### end Alembic commands ### 24​ ### end Alembic commands ###
24 25​
25 26​
26def downgrade(): 27​def downgrade():
27 ### commands auto generated by Alembic - please adjust! ### 28​ ### commands auto generated by Alembic - please adjust! ###
28 op.alter_column('testcase', 'name', type_=sa.String(255)) 29​ op.alter_column('testcase', 'name', type_=sa.String(255))
29 op.drop_index('testcase_idx_name', table_name='testcase') 30​ op.drop_index('testcase_idx_name', table_name='testcase')
30 ### end Alembic commands ### 31​ ### end Alembic commands ###
View Options

alembic/versions/dbfab576c81_change_schema_to_v2_0_step_2.py

  • This file was added.
1​"""Change schema to v2.0 - step 2 - data migration
2​
3​Revision ID: dbfab576c81
4​Revises: 540dbe71fa91
5​Create Date: 2016-08-23 23:02:56.928292
6​
7​"""
8​
9​# revision identifiers, used by Alembic.
10​revision = 'dbfab576c81'
11​down_revision = '540dbe71fa91'
12​branch_labels = None
13​depends_on = None
14​
15​from alembic import op
16​import sqlalchemy as db
17​from sqlalchemy.ext.declarative import declarative_base
18​from sqlalchemy.orm import relationship, relation, sessionmaker
19​import uuid
20​
21​Session = sessionmaker()
22​Base = declarative_base()
23​
24​
25​db.relationship = relationship
26​db.relation = relation
27​
28​RESULT_OUTCOME = ('PASSED', 'INFO', 'FAILED', 'NEEDS_INSPECTION')
29​JOB_STATUS = []
30​
31​
32​class GroupsToResults(Base):
33​ __tablename__ = 'groups_to_results'
34​ id = db.Column(db.Integer, primary_key=True)
35​ group_uuid = db.Column(db.String(36), db.ForeignKey('group.uuid'))
36​ result_id = db.Column(db.Integer, db.ForeignKey('result.id'))
37​
38​
39​class Group(Base):
40​ __tablename__ = 'group'
41​
42​ id = db.Column(db.Integer, primary_key=True)
43​ uuid = db.Column(db.String(36), unique=True)
44​# results = db.relationship("Result", secondary = 'groups_to_results', backref="groups")
45​
46​
47​class Testcase(Base):
48​ __tablename__ = 'testcase'
49​
50​ id = db.Column(db.Integer, primary_key=True)
51​ name = db.Column(db.Text, unique=True)
52​
53​
54​def upgrade():
55​ class Result(Base):
56​ __tablename__ = 'result'
57​
58​ id = db.Column(db.Integer, primary_key=True)
59​ job_id = db.Column(db.Integer, db.ForeignKey('group.id'))
60​ testcase_id = db.Column(db.Integer, db.ForeignKey('testcase.id'))
61​ testcase_name = db.Column(db.Text)
62​
63​ groups = db.relationship("Group", secondary='groups_to_results', backref="results")
64​ job = db.relation('Group') # , lazy = False)
65​ testcase = db.relation('Testcase', backref='results') # , lazy = False)
66​
67​ connection = op.get_bind()
68​ session = Session(bind=connection)
69​ for group in session.query(Group):
70​ if not group.uuid:
71​ group.uuid = str(uuid.uuid1())
72​ session.add(group)
73​ session.commit()
74​ for result in session.query(Result):
75​ result.groups = [result.job]
76​ result.testcase_name = result.testcase.name
77​ session.add(result)
78​ session.commit()
79​ op.drop_column('result', 'testcase_id')
80​ op.drop_column('result', 'job_id')
81​
82​
83​def downgrade():
84​ class Result(Base):
85​ __tablename__ = 'result'
86​
87​ id = db.Column(db.Integer, primary_key=True)
88​ job_id = db.Column(db.Integer, db.ForeignKey('group.id'))
89​ testcase_id = db.Column(db.Integer)
90​ testcase_name = db.Column(db.Text, db.ForeignKey('testcase.name'))
91​
92​ groups = db.relationship("Group", secondary='groups_to_results', backref="results")
93​ job = db.relation('Group') # , lazy = False)
94​ testcase = db.relation('Testcase', backref='results') # , lazy = False)
95​
96​ op.add_column('result', db.Column('job_id', db.INTEGER(), autoincrement=False, nullable=True))
97​ op.add_column('result', db.Column(
98​ 'testcase_id', db.INTEGER(), autoincrement=False, nullable=True))
99​
100​ connection = op.get_bind()
101​ session = Session(bind=connection)
102​ for result in session.query(Result):
103​ result.job_id = result.groups[0].id
104​ result.testcase_id = result.testcase.id
105​ session.add(result)
106​ session.commit()
View Options

migration.sh

  • This file was added.
1​git commit -am .
2​docker stop pg_resultsdb;docker rm pg_resultsdb;docker run --name pg_resultsdb -e POSTGRES_USER=resultsdb -e POSTGRES_PASSWORD=fedora -p 5432:5432 -d postgres
tflinkUnsubmitted
Not Done

was this supposed to be part of the revision?

jskladanAuthorUnsubmitted
Not Done

oops, missed this one bugger, thanks!

3​sleep 10
4​git co 5dc67d8382dd0c0aaf5b9d74df4dd2c00585af4e; DEV=true bash init_db.sh; git co feature/v20
5​DEV=true alembic upgrade 540dbe71fa91
6​
7​
8​#DEV=true alembic upgrade head
View Options

resultsdb/__init__.py

Show All 25 Lines
26from flask.ext.sqlalchemy import SQLAlchemy 26​from flask.ext.sqlalchemy import SQLAlchemy
27 27​
28import logging 28​import logging
29import logging.handlers 29​import logging.handlers
30import os 30​import os
31 31​
32 32​
33# the version as used in setup.py 33​# the version as used in setup.py
34__version__ = "1.1.16" 34​__version__ = "1.1.16"
tflinkUnsubmitted
Not Done

Shouldn't this version be bumped with such a major change?

jskladanAuthorUnsubmitted
Not Done

Absolutely, I just though we'd bump it before release, together with specfile.
But I can absolutely do it in the revision, too.

35 35​
36 36​
37# Flask App 37​# Flask App
38app = Flask(__name__) 38​app = Flask(__name__)
39app.secret_key = 'replace-me-with-something-random' 39​app.secret_key = 'replace-me-with-something-random'
40 40​
41# make sure app behaves when behind a proxy 41​# make sure app behaves when behind a proxy
42app.wsgi_app = proxy.ReverseProxied(app.wsgi_app) 42​app.wsgi_app = proxy.ReverseProxied(app.wsgi_app)
43 43​
44# Monkey patch Flask's "jsonify" to also handle JSONP 44​# Monkey patch Flask's "jsonify" to also handle JSONP
45original_jsonify = flask.jsonify 45​original_jsonify = flask.jsonify
46 46​
47# Expose the __version__ variable in templates 47​# Expose the __version__ variable in templates
48app.jinja_env.globals['app_version'] = __version__ 48​app.jinja_env.globals['app_version'] = __version__
49 49​
50​
50def jsonify_with_jsonp(*args, **kwargs): 51​def jsonify_with_jsonp(*args, **kwargs):
51 response = original_jsonify(*args, **kwargs) 52​ response = original_jsonify(*args, **kwargs)
52 53​
53 callback = flask.request.args.get('callback', None) 54​ callback = flask.request.args.get('callback', None)
54 55​
55 if callback: 56​ if callback:
56 if not isinstance(callback, basestring): 57​ if not isinstance(callback, basestring):
57 callback = callback[0] 58​ callback = callback[0]
Show All 28 Lines
86 87​
87# setup logging 88​# setup logging
88fmt = '[%(filename)s:%(lineno)d] ' if app.debug else '%(module)-12s ' 89​fmt = '[%(filename)s:%(lineno)d] ' if app.debug else '%(module)-12s '
89fmt += '%(asctime)s %(levelname)-7s %(message)s' 90​fmt += '%(asctime)s %(levelname)-7s %(message)s'
90datefmt = '%Y-%m-%d %H:%M:%S' 91​datefmt = '%Y-%m-%d %H:%M:%S'
91loglevel = logging.DEBUG if app.debug else logging.INFO 92​loglevel = logging.DEBUG if app.debug else logging.INFO
92formatter = logging.Formatter(fmt=fmt, datefmt=datefmt) 93​formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
93 94​
95​
94def setup_logging(): 96​def setup_logging():
95 root_logger = logging.getLogger('') 97​ root_logger = logging.getLogger('')
96 root_logger.setLevel(logging.DEBUG) 98​ root_logger.setLevel(logging.DEBUG)
97 99​
98 if app.config['STREAM_LOGGING']: 100​ if app.config['STREAM_LOGGING']:
99 print "doing stream logging" 101​ print "doing stream logging"
100 stream_handler = logging.StreamHandler() 102​ stream_handler = logging.StreamHandler()
101 stream_handler.setLevel(loglevel) 103​ stream_handler.setLevel(loglevel)
102 stream_handler.setFormatter(formatter) 104​ stream_handler.setFormatter(formatter)
103 root_logger.addHandler(stream_handler) 105​ root_logger.addHandler(stream_handler)
104 app.logger.addHandler(stream_handler) 106​ app.logger.addHandler(stream_handler)
105 107​
106 if app.config['SYSLOG_LOGGING']: 108​ if app.config['SYSLOG_LOGGING']:
107 print "doing syslog logging" 109​ print "doing syslog logging"
108 syslog_handler = logging.handlers.SysLogHandler(address='/dev/log', 110​ syslog_handler = logging.handlers.SysLogHandler(address='/dev/log',
109 facility=logging.handlers.SysLogHandler.LOG_LOCAL4) 111​ facility=logging.handlers.SysLogHandler.LOG_LOCAL4)
110 syslog_handler.setLevel(loglevel) 112​ syslog_handler.setLevel(loglevel)
111 syslog_handler.setFormatter(formatter) 113​ syslog_handler.setFormatter(formatter)
112 root_logger.addHandler(syslog_handler) 114​ root_logger.addHandler(syslog_handler)
113 app.logger.addHandler(syslog_handler) 115​ app.logger.addHandler(syslog_handler)
114 116​
115 if app.config['FILE_LOGGING'] and app.config['LOGFILE']: 117​ if app.config['FILE_LOGGING'] and app.config['LOGFILE']:
116 print "doing file logging to %s" % app.config['LOGFILE'] 118​ print "doing file logging to %s" % app.config['LOGFILE']
117 file_handler = logging.handlers.RotatingFileHandler(app.config['LOGFILE'], maxBytes=500000, backupCount=5) 119​ file_handler = logging.handlers.RotatingFileHandler(
120​ app.config['LOGFILE'], maxBytes=500000, backupCount=5)
118 file_handler.setLevel(loglevel) 121​ file_handler.setLevel(loglevel)
119 file_handler.setFormatter(formatter) 122​ file_handler.setFormatter(formatter)
120 root_logger.addHandler(file_handler) 123​ root_logger.addHandler(file_handler)
121 app.logger.addHandler(file_handler) 124​ app.logger.addHandler(file_handler)
122 125​
123setup_logging() 126​setup_logging()
124 127​
125if app.config['SHOW_DB_URI']: 128​if app.config['SHOW_DB_URI']:
Show All 14 Lines
140 143​
141from resultsdb.controllers.login_page import login_page 144​from resultsdb.controllers.login_page import login_page
142app.register_blueprint(login_page) 145​app.register_blueprint(login_page)
143 146​
144from resultsdb.controllers.admin import admin 147​from resultsdb.controllers.admin import admin
145app.register_blueprint(admin) 148​app.register_blueprint(admin)
146 149​
147from resultsdb.controllers.api_v1 import api as api_v1 150​from resultsdb.controllers.api_v1 import api as api_v1
148app.register_blueprint(api_v1, url_prefix = "/api") 151​app.register_blueprint(api_v1, url_prefix="/api/v1.0")
152​
153​from resultsdb.controllers.api_v2 import api as api_v2
154​app.register_blueprint(api_v2, url_prefix="/api/v2.0")
View Options

resultsdb/cli.py

Show All 11 Lines
12# 12​#
13# You should have received a copy of the GNU General Public License along 13​# You should have received a copy of the GNU General Public License along
14# with this program; if not, write to the Free Software Foundation, Inc., 14​# with this program; if not, write to the Free Software Foundation, Inc.,
15# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16# 16​#
17# Authors: 17​# Authors:
18# Josef Skladanka <jskladan@redhat.com> 18​# Josef Skladanka <jskladan@redhat.com>
19 19​
20# This is required for running on EL6 ​
21import __main__ ​
22__main__.__requires__ = ['SQLAlchemy >= 0.7', 'Flask >= 0.9', 'jinja2 >= 2.6'] ​
23import pkg_resources ​
24 ​
25import os 20​import os
26import sys 21​import sys
27import datetime ​
28from optparse import OptionParser 22​from optparse import OptionParser
29 23​
30from alembic.config import Config 24​from alembic.config import Config
31from alembic import command as al_command 25​from alembic import command as al_command
32from alembic.migration import MigrationContext 26​from alembic.migration import MigrationContext
33 27​
34from resultsdb import db 28​from resultsdb import db
35from resultsdb.models.user import User 29​from resultsdb.models.user import User
36from resultsdb.models.results import Job, Testcase, Result, ResultData 30​from resultsdb.models.results import Group, Testcase, Result, ResultData
37 31​
38from sqlalchemy.engine import reflection 32​from sqlalchemy.engine import reflection
39 33​
40def get_alembic_config(): 34​def get_alembic_config():
41 # the location of the alembic ini file and alembic scripts changes when 35​ # the location of the alembic ini file and alembic scripts changes when
42 # installed via package 36​ # installed via package
43 if os.path.exists("./alembic.ini"): 37​ if os.path.exists("./alembic.ini"):
44 alembic_cfg = Config("./alembic.ini") 38​ alembic_cfg = Config("./alembic.ini")
45 else: 39​ else:
46 alembic_cfg = Config("/usr/share/resultsdb/alembic.ini", 40​ alembic_cfg = Config("/usr/share/resultsdb/alembic.ini",
47 ini_section='alembic-packaged') 41​ ini_section='alembic-packaged')
48 return alembic_cfg 42​ return alembic_cfg
49 43​
44​
50def upgrade_db(*args): 45​def upgrade_db(*args):
51 print "Upgrading Database to Latest Revision" 46​ print "Upgrading Database to Latest Revision"
52 alembic_cfg = get_alembic_config() 47​ alembic_cfg = get_alembic_config()
53 al_command.upgrade(alembic_cfg, "head") 48​ al_command.upgrade(alembic_cfg, "head")
54 49​
50​
55def init_alembic(*args): 51​def init_alembic(*args):
56 alembic_cfg = get_alembic_config() 52​ alembic_cfg = get_alembic_config()
57 53​
58 # check to see if the db has already been initialized by checking for an 54​ # check to see if the db has already been initialized by checking for an
59 # alembic revision 55​ # alembic revision
60 context = MigrationContext.configure(db.engine.connect()) 56​ context = MigrationContext.configure(db.engine.connect())
61 current_rev = context.get_current_revision() 57​ current_rev = context.get_current_revision()
62 58​
63 if not current_rev: 59​ if not current_rev:
64 print "Initializing alembic" 60​ print "Initializing alembic"
65 print " - Setting the current version to the first revision" 61​ print " - Setting the current version to the first revision"
66 al_command.stamp(alembic_cfg, "15f5eeb9f635") 62​ al_command.stamp(alembic_cfg, "15f5eeb9f635")
67 else: 63​ else:
68 print "Alembic already initialized" 64​ print "Alembic already initialized"
69 65​
66​
70def initialize_db(destructive): 67​def initialize_db(destructive):
71 alembic_cfg = get_alembic_config() 68​ alembic_cfg = get_alembic_config()
72 69​
73 print "Initializing database" 70​ print "Initializing database"
74 71​
75 if destructive: 72​ if destructive:
76 print " - Dropping all tables" 73​ print " - Dropping all tables"
77 db.drop_all() 74​ db.drop_all()
78 75​
79 # check whether the table 'job' exists 76​ # check whether the table 'group' exists
80 # if it does, we assume that the database is empty 77​ # if it does, we assume that the database is empty
81 insp = reflection.Inspector.from_engine(db.engine) 78​ insp = reflection.Inspector.from_engine(db.engine)
82 table_names = insp.get_table_names() 79​ table_names = insp.get_table_names()
83 if 'job' not in table_names and 'Job' not in table_names: 80​ if 'group' not in table_names and 'Group' not in table_names:
84 print " - Creating tables" 81​ print " - Creating tables"
85 db.create_all() 82​ db.create_all()
86 print " - Stamping alembic's current version to 'head'" 83​ print " - Stamping alembic's current version to 'head'"
87 al_command.stamp(alembic_cfg, "head") 84​ al_command.stamp(alembic_cfg, "head")
88 85​
89 # check to see if the db has already been initialized by checking for an 86​ # check to see if the db has already been initialized by checking for an
90 # alembic revision 87​ # alembic revision
91 context = MigrationContext.configure(db.engine.connect()) 88​ context = MigrationContext.configure(db.engine.connect())
92 current_rev = context.get_current_revision() 89​ current_rev = context.get_current_revision()
93 if current_rev: 90​ if current_rev:
94 print " - Database is currently at rev %s" % current_rev 91​ print " - Database is currently at rev %s" % current_rev
95 upgrade_db(destructive) 92​ upgrade_db(destructive)
96 else: 93​ else:
97 print "WARN: You need to have your db stamped with an alembic revision" 94​ print "WARN: You need to have your db stamped with an alembic revision"
98 print " Run 'init_alembic' sub-command first." 95​ print " Run 'init_alembic' sub-command first."
99 96​
97​
100def mock_data(destructive): 98​def mock_data(destructive):
101 print "Populating tables with mock-data" 99​ print "Populating tables with mock-data"
102 100​
103 if destructive or not db.session.query(User).count(): 101​ if destructive or not db.session.query(User).count():
104 print " - User" 102​ print " - User"
105 data_users = [('admin', 'admin'), ('user', 'user')] 103​ data_users = [('admin', 'admin'), ('user', 'user')]
106 104​
107 for d in data_users: 105​ for d in data_users:
108 u = User(*d) 106​ u = User(*d)
109 db.session.add(u) 107​ db.session.add(u)
110 108​
111 db.session.commit() 109​ db.session.commit()
112 else: 110​ else:
113 print " - skipped User" 111​ print " - skipped User"
114 112​
115 if destructive or not db.session.query(Testcase).count(): 113​ if destructive or not db.session.query(Testcase).count():
116 print " - Testcase, Job, Result, ResultData" 114​ print " - Testcase, Job, Result, ResultData"
117 tc1 = Testcase( url = "http://example.com/depcheck", name = "depcheck") 115​ tc1 = Testcase(ref_url="http://example.com/depcheck", name="depcheck")
118 tc2 = Testcase( url = "http://example.com/rpmlint", name = "rpmlint") 116​ tc2 = Testcase(ref_url="http://example.com/rpmlint", name="rpmlint")
119 117​
120 j1 = Job(status = "COMPLETED", ref_url = "http://example.com/job1") 118​ j1 = Group(uuid='5b3f47b4-2ba2-11e5-a343-5254007dccf9', ref_url="http://example.com/job1")
121 j1.start_time = datetime.datetime(2013, 6, 1, 12, 0, 0) ​
122 j1.end_time = datetime.datetime(2013, 6, 1, 12, 30, 0) ​
123 j1.uuid = '5b3f47b4-2ba2-11e5-a343-5254007dccf9' ​
124 119​
125 j2 = Job(status = "RUNNING", ref_url = "http://example.com/job2") 120​ j2 = Group(uuid='4e575b2c-2ba2-11e5-a343-5254007dccf9', ref_url="http://example.com/job2")
126 j2.start_time = datetime.datetime(2013, 7, 1, 16, 0, 0) ​
127 j2.end_time = datetime.datetime(2013, 7, 1, 16, 30, 0) ​
128 j2.uuid = '4e575b2c-2ba2-11e5-a343-5254007dccf9' ​
129 121​
130 r1 = Result(job = j1, testcase = tc1, outcome = 'PASSED', log_url = "http://example.com/r1") 122​ r1 = Result(groups=[j1], testcase=tc1, outcome='PASSED', ref_url="http://example.com/r1")
131 r2 = Result(job = j1, testcase = tc1, outcome = 'FAILED', log_url = "http://example.com/r2") 123​ r2 = Result(
132 r3 = Result(job = j2, testcase = tc2, outcome = 'FAILED', log_url = "http://example.com/r2") 124​ groups=[j1, j2],
125​ testcase=tc1,
126​ outcome='FAILED',
127​ ref_url="http://example.com/r2"
128​ )
129​ r3 = Result(groups=[j2], testcase=tc2, outcome='FAILED', ref_url="http://example.com/r2")
133 130​
134 rd = ResultData(r1, "item", "cabal-rpm-0.8.3-1.fc18") 131​ ResultData(r1, "item", "cabal-rpm-0.8.3-1.fc18")
135 rd = ResultData(r1, "arch", "x86_64") 132​ ResultData(r1, "arch", "x86_64")
136 rd = ResultData(r1, "type", "koji_build") 133​ ResultData(r1, "type", "koji_build")
137 134​
138 rd = ResultData(r2, "item", "htop-1.0-1.fc22") 135​ ResultData(r2, "item", "htop-1.0-1.fc22")
139 rd = ResultData(r2, "arch", "i386") 136​ ResultData(r2, "arch", "i386")
140 rd = ResultData(r2, "type", "bodhi_update") 137​ ResultData(r2, "type", "bodhi_update")
141 138​
142 rd = ResultData(r3, "item", "cabal-rpm-0.8.3-1.fc18") 139​ ResultData(r3, "item", "cabal-rpm-0.8.3-1.fc18")
143 rd = ResultData(r3, "arch", "i386") 140​ ResultData(r3, "arch", "i386")
144 rd = ResultData(r3, "type", "bodhi_update") 141​ ResultData(r3, "type", "bodhi_update")
145 142​
146 db.session.add(tc1) 143​ db.session.add(tc1)
147 db.session.add(j1) 144​ db.session.add(j1)
148 db.session.add(j2) 145​ db.session.add(j2)
149 146​
150 db.session.commit() 147​ db.session.commit()
151 else: 148​ else:
152 print " - skipped Testcase, Job, Result, ResultData" 149​ print " - skipped Testcase, Job, Result, ResultData"
153 150​
154 151​
155def main(): 152​def main():
156 possible_commands = ['init_db', 'mock_data', 'upgrade_db', 'init_alembic'] 153​ possible_commands = ['init_db', 'mock_data', 'upgrade_db', 'init_alembic']
157 154​
158 usage = 'usage: [DEV=true] %prog ' + "(%s)" % ' | '.join(possible_commands) 155​ usage = 'usage: [DEV=true] %prog ' + "(%s)" % ' | '.join(possible_commands)
159 parser = OptionParser(usage=usage) 156​ parser = OptionParser(usage=usage)
160 parser.add_option("-d", "--destructive", 157​ parser.add_option("-d", "--destructive",
161 action="store_true", dest="destructive", default=False, 158​ action="store_true", dest="destructive", default=False,
162 help="Drop tables in `init_db`; Store data in `mock_data` " 159​ help="Drop tables in `init_db`; Store data in `mock_data` "
163 "even if the tables are not empty") 160​ "even if the tables are not empty")
164 161​
165 (options, args) = parser.parse_args() 162​ (options, args) = parser.parse_args()
166 163​
167 if len(args) != 1 or args[0] not in possible_commands: 164​ if len(args) != 1 or args[0] not in possible_commands:
168 print usage 165​ print usage
169 print 166​ print
170 print 'Please use one of the following commands: %s' % str(possible_commands) 167​ print 'Please use one of the following commands: %s' % str(possible_commands)
171 sys.exit(1) 168​ sys.exit(1)
172 169​
173 command = { 170​ command = {
174 'init_db': initialize_db, 171​ 'init_db': initialize_db,
175 'upgrade_db': upgrade_db, 172​ 'upgrade_db': upgrade_db,
176 'mock_data': mock_data, 173​ 'mock_data': mock_data,
177 'init_alembic': init_alembic, 174​ 'init_alembic': init_alembic,
178 }[args[0]] 175​ }[args[0]]
179 176​
180 if not options.destructive: 177​ if not options.destructive:
181 print "Proceeding in non-destructive mode. To perform destructive "\ 178​ print "Proceeding in non-destructive mode. To perform destructive "\
182 "steps use -d option." 179​ "steps use -d option."
183 180​
184 command(options.destructive) 181​ command(options.destructive)
185 182​
186 sys.exit(0) 183​ sys.exit(0)
187 184​
188 185​
189if __name__ == '__main__': 186​if __name__ == '__main__':
190 main() 187​ main()
View Options

resultsdb/controllers/admin.py

Show All 12 Lines
13# You should have received a copy of the GNU General Public License along 13​# You should have received a copy of the GNU General Public License along
14# with this program; if not, write to the Free Software Foundation, Inc., 14​# with this program; if not, write to the Free Software Foundation, Inc.,
15# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16# 16​#
17# Authors: 17​# Authors:
18# Josef Skladanka <jskladan@redhat.com> 18​# Josef Skladanka <jskladan@redhat.com>
19 19​
20 20​
21from flask import Blueprint, render_template, flash, url_for 21​from flask import Blueprint, render_template
22from flask.ext.login import login_required 22​from flask.ext.login import login_required
23 23​
24 24​
25admin = Blueprint('admin', __name__) 25​admin = Blueprint('admin', __name__)
26 26​
27​
27@admin.route('/admin') 28​@admin.route('/admin')
28@admin.route('/admin/') 29​@admin.route('/admin/')
29@login_required 30​@login_required
30def admin_index(): 31​def admin_index():
31 return render_template('admin/index.html') 32​ return render_template('admin/index.html')
32 ​
View Options

resultsdb/controllers/api_v1.py

Show All 12 Lines
13# You should have received a copy of the GNU General Public License along 13​# You should have received a copy of the GNU General Public License along
14# with this program; if not, write to the Free Software Foundation, Inc., 14​# with this program; if not, write to the Free Software Foundation, Inc.,
15# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16# 16​#
17# Authors: 17​# Authors:
18# Josef Skladanka <jskladan@redhat.com> 18​# Josef Skladanka <jskladan@redhat.com>
19# Ralph Bean <rbean@redhat.com> 19​# Ralph Bean <rbean@redhat.com>
20 20​
21import datetime ​
22import math ​
23import re 21​import re
24from functools import partial 22​import uuid
25 23​
26from flask import Blueprint, jsonify, request, url_for, abort 24​from flask import Blueprint, jsonify, request, url_for
27from flask.ext.restful import reqparse 25​from flask.ext.restful import reqparse
28 26​
29from sqlalchemy.orm import exc as orm_exc 27​from sqlalchemy.orm import exc as orm_exc
30from sqlalchemy import exc as sqlalchemy_exc 28​from sqlalchemy import exc as sqlalchemy_exc
31from werkzeug.exceptions import HTTPException 29​from werkzeug.exceptions import HTTPException
32 30​
33 31​
34# removed in flask 0.10 from flask.exceptions import JSONBadRequest 32​# removed in flask 0.10 from flask.exceptions import JSONBadRequest
35from werkzeug.exceptions import BadRequest as JSONBadRequest 33​from werkzeug.exceptions import BadRequest as JSONBadRequest
36 34​
37import iso8601 35​import iso8601
38import fedmsg 36​import fedmsg
39 37​
40from resultsdb import app, db 38​from resultsdb import app, db
41from resultsdb.serializers.api_v1 import Serializer 39​from resultsdb.serializers.api_v1 import Serializer
42from resultsdb.models.results import Job, Result, Testcase, ResultData 40​from resultsdb.models.results import Group, Result, Testcase, ResultData
43from resultsdb.models.results import JOB_STATUS, RESULT_OUTCOME 41​from resultsdb.models.results import JOB_STATUS, RESULT_OUTCOME
44 42​
45QUERY_LIMIT = 20 43​QUERY_LIMIT = 20
46 44​
47api = Blueprint('api_v1', __name__) 45​api = Blueprint('api_v1', __name__)
48 46​
49##TODO: find out why error handler works for 404 but not fot 400 47​# TODO: find out why error handler works for 404 but not fot 400
48​
tflinkUnsubmitted
Not Done

s/fot/for

50 49​
51@app.errorhandler(400) 50​@app.errorhandler(400)
52def bad_request(error): 51​def bad_request(error):
53 return jsonify({"message": "Bad request"}), 400 52​ return jsonify({"message": "Bad request"}), 400
54 53​
55 54​
56@app.errorhandler(404) 55​@app.errorhandler(404)
57def not_found(error): 56​def not_found(error):
58 return jsonify({"message": "Not found"}), 404 57​ return jsonify({"message": "Not found"}), 404
59 58​
60# ============================================================================= 59​# =============================================================================
61# GLOBAL VARIABLES 60​# GLOBAL VARIABLES
62# ============================================================================= 61​# =============================================================================
63 62​
64RE_PAGE = re.compile(r"([?&])page=([0-9]+)") 63​RE_PAGE = re.compile(r"([?&])page=([0-9]+)")
65 64​
66# RP contains request parsers (reqparse.RequestParser). 65​# RP contains request parsers (reqparse.RequestParser).
67# Parsers are added in each 'resource section' for better readability 66​# Parsers are added in each 'resource section' for better readability
68RP = {} 67​RP = {}
69 68​
70# Serializer and URI helper to generate urls for resources 69​# Serializer and URI helper to generate urls for resources
70​
71​
71def __get_uri(o): 72​def __get_uri(o):
72 cls = o.__class__.__name__ 73​ cls = o.__class__.__name__
73 74​
74 if cls == 'Job': 75​ if cls == 'Group':
75 return url_for('api_v1.get_job', job_id = o.id, _external = True) 76​ return url_for('api_v1.get_job', job_id=o.uuid, _external=True)
76 if cls == 'Testcase': 77​ if cls == 'Testcase':
77 return url_for('api_v1.get_testcase', testcase_name = o.name, _external = True) 78​ return url_for('api_v1.get_testcase', testcase_name=o.name, _external=True)
78 if cls == 'Result': 79​ if cls == 'Result':
79 return url_for('api_v1.get_result', result_id = o.id, _external = True) 80​ return url_for('api_v1.get_result', result_id=o.id, _external=True)
80 81​
81__serializer = Serializer(__get_uri) 82​__serializer = Serializer(__get_uri)
82SERIALIZE = __serializer.serialize 83​SERIALIZE = __serializer.serialize
83 84​
84# ============================================================================= 85​# =============================================================================
85# GLOBAL METHODS 86​# GLOBAL METHODS
86# ============================================================================= 87​# =============================================================================
87 88​
89​
88def pagination(q, page, limit): 90​def pagination(q, page, limit):
89 91​
90 # pagination offset 92​ # pagination offset
91 try: 93​ try:
92 page = int(page) 94​ page = int(page)
93 if page > 0: 95​ if page > 0:
94 offset = page * limit 96​ offset = page * limit
95 q = q.offset(offset) 97​ q = q.offset(offset)
96 except (TypeError, ValueError): 98​ except (TypeError, ValueError):
97 pass 99​ pass
98 100​
99 # apply the query limit 101​ # apply the query limit
100 try: 102​ try:
101 limit = int(limit) 103​ limit = int(limit)
102 except (ValueError, TypeError): 104​ except (ValueError, TypeError):
103 limit = QUERY_LIMIT 105​ limit = QUERY_LIMIT
104 106​
105 q = q.limit(limit) 107​ q = q.limit(limit)
106 return q 108​ return q
107 109​
108#TODO: find a better way to do this 110​# TODO: find a better way to do this
111​
112​
109def prev_next_urls(): 113​def prev_next_urls():
110 global RE_PAGE 114​ global RE_PAGE
111 try: 115​ try:
112 match = RE_PAGE.findall(request.url) 116​ match = RE_PAGE.findall(request.url)
113 flag, page = match[0][0], int(match[0][1]) 117​ flag, page = match[0][0], int(match[0][1])
114 except IndexError: #page not found 118​ except IndexError: # page not found
115 if '?' in request.url: 119​ if '?' in request.url:
116 return None, "%s&page=1" % request.url 120​ return None, "%s&page=1" % request.url
117 else: 121​ else:
118 return None, "%s?page=1" % request.url 122​ return None, "%s?page=1" % request.url
119 123​
120 prev = None 124​ prev = None
121 next = None 125​ next = None
122 prevpage = page - 1 126​ prevpage = page - 1
123 nextpage = page + 1 127​ nextpage = page + 1
124 128​
125 if page > 0: 129​ if page > 0:
126 prev = RE_PAGE.sub("%spage=%s" % (flag, prevpage), request.url) 130​ prev = RE_PAGE.sub("%spage=%s" % (flag, prevpage), request.url)
127 next = RE_PAGE.sub("%spage=%s" % (flag, nextpage), request.url) 131​ next = RE_PAGE.sub("%spage=%s" % (flag, nextpage), request.url)
128 132​
129 return prev, next 133​ return prev, next
130 134​
131 135​
132 ​
133def parse_since(since): 136​def parse_since(since):
134 since_start = None 137​ since_start = None
135 since_end = None 138​ since_end = None
136 if since is not None: 139​ if since is not None:
137 s = since.split(',') 140​ s = since.split(',')
138 try: 141​ try:
139 since_start = iso8601.parse_date(s[0]) 142​ since_start = iso8601.parse_date(s[0])
140 # https://phab.qadevel.cloud.fedoraproject.org/T246 143​ # https://phab.qadevel.cloud.fedoraproject.org/T246
141 since_start = since_start.replace(tzinfo=None) # we need to strip timezone info 144​ since_start = since_start.replace(tzinfo=None) # we need to strip timezone info
142 except (TypeError, ValueError, iso8601.iso8601.ParseError): # Yes, this library sucks in Exception handling.. 145​ # Yes, this library sucks in Exception handling..
146​ except (TypeError, ValueError, iso8601.iso8601.ParseError):
143 raise iso8601.iso8601.ParseError() 147​ raise iso8601.iso8601.ParseError()
144 try: 148​ try:
145 since_end = iso8601.parse_date(s[1]) 149​ since_end = iso8601.parse_date(s[1])
146 # https://phab.qadevel.cloud.fedoraproject.org/T246 150​ # https://phab.qadevel.cloud.fedoraproject.org/T246
147 since_end = since_end.replace(tzinfo=None) # we need to strip timezone info 151​ since_end = since_end.replace(tzinfo=None) # we need to strip timezone info
148 except IndexError: # since contained just one datetime 152​ except IndexError: # since contained just one datetime
149 pass 153​ pass
150 except (TypeError, ValueError, iso8601.iso8601.ParseError): # Yes, this library sucks in Exception handling.. 154​ # Yes, this library sucks in Exception handling..
155​ except (TypeError, ValueError, iso8601.iso8601.ParseError):
151 raise iso8601.iso8601.ParseError() 156​ raise iso8601.iso8601.ParseError()
152 return since_start, since_end 157​ return since_start, since_end
153 158​
154 159​
155def select_jobs(since_start = None, since_end = None, status = None, name = None): 160​def select_jobs(since_start=None, since_end=None, status=None, name=None):
156 q = db.session.query(Job) 161​ q = db.session.query(Group)
157 ​
158 # Time constraints ​
159 if since_start is not None: ​
160 q = q.filter(Job.start_time >= since_start) ​
161 if since_end is not None: ​
162 q = q.filter(Job.start_time <= since_end) ​
163 ​
164 # Filter by status ​
165 if status is not None: ​
166 q = q.filter(Job.status.in_([o.strip().upper() for o in status.split(',')])) ​
167 162​
168 # Filter by name 163​ # Filter by name
169 if name is not None: 164​ if name is not None:
170 q = q.filter(Job.name.like('%%%s%%' % name)) 165​ q = q.filter(Group.description.like('%%%s%%' % name))
171 166​
172 q = q.order_by(db.desc(Job.start_time)) 167​ q = q.order_by(db.desc(Group.id))
173 168​
174 return q 169​ return q
175 170​
176def select_results(since_start = None, since_end = None, outcome = None, since_source = None, job_id = None, testcase_name = None, result_data = None): 171​
172​def select_results(since_start=None, since_end=None, outcome=None, since_source=None, job_id=None, testcase_name=None, result_data=None):
177 q = db.session.query(Result) 173​ q = db.session.query(Result)
178 174​
179 # Time constraints 175​ # Time constraints
180 176​
181 # TODO: Find a way to do this 'better' without multiple (aka aliased) joins ​
182 # Time constraints (args['since']) and ordering by Job.startt_time ​
183 if since_start or since_end: 177​ if since_start or since_end:
184 if since_source == 'job': 178​ if since_start and since_end:
185 if since_start and since_end: 179​ q = q.order_by(db.desc(Result.submit_time)).filter(
186 q = q.join(Job).order_by(db.desc(Job.start_time)).filter(Job.start_time >= since_start, Job.start_time <= since_end) 180​ Result.submit_time >= since_start, Result.submit_time <= since_end)
187 else: #means "just since_start" 181​ else: # means "just since_start"
188 q = q.join(Job).order_by(db.desc(Job.start_time)).filter(Job.start_time >= since_start) 182​ q = q.order_by(db.desc(Result.submit_time)).filter(Result.submit_time >= since_start)
189 else: 183​
190 if since_start and since_end: 184​ q = q.order_by(db.desc(Result.submit_time))
191 q = q.order_by(db.desc(Result.submit_time)).filter(Result.submit_time >= since_start, Result.submit_time <= since_end) ​
192 else: #means "just since_start" ​
193 q = q.order_by(db.desc(Result.submit_time)).filter(Result.submit_time >= since_start) ​
194 ​
195 else: ​
196 if since_source == 'job': ​
197 q = q.join(Job).order_by(db.desc(Job.start_time)) ​
198 else: ​
199 q = q.order_by(db.desc(Result.submit_time)) ​
200 185​
201 # Filter by outcome 186​ # Filter by outcome
202 if outcome is not None: 187​ if outcome is not None:
203 q = q.filter(Result.outcome.in_([o.strip().upper() for o in outcome.split(',')])) 188​ q = q.filter(Result.outcome.in_([o.strip().upper() for o in outcome.split(',')]))
204 189​
205 # Filter by job_id 190​ # Filter by job_id
206 if job_id is not None: 191​ if job_id is not None:
207 try: 192​ try:
208 job_id = int(job_id) 193​ job_id = int(job_id)
209 except ValueError: # uuid can not be parsed to int 194​ except ValueError: # uuid can not be parsed to int
210 alias = db.aliased(Job) 195​ q = q.filter(Result.groups.any(uuid=job_id))
211 q = q.join(alias).filter(alias.uuid == job_id) 196​ else: # id was int -> filter by id
212 else: # id was int -> filter by id 197​ q = q.filter(Result.groups.any(id=job_id))
213 q = q.filter(Result.job_id == job_id) ​
214 198​
215 # Filter by testcase_name 199​ # Filter by testcase_name
216 if testcase_name is not None: 200​ if testcase_name is not None:
217 alias = db.aliased(Testcase) 201​ alias = db.aliased(Testcase)
218 q = q.join(alias).filter(alias.name == testcase_name) 202​ q = q.filter(Result.testcase_name == testcase_name)
219 203​
220 # Filter by result_data 204​ # Filter by result_data
221 if result_data is not None: 205​ if result_data is not None:
222 for key, values in result_data.iteritems(): 206​ for key, values in result_data.iteritems():
223 try: 207​ try:
224 key, modifier = key.split(':') 208​ key, modifier = key.split(':')
225 except ValueError: #no : in key 209​ except ValueError: # no : in key
226 key, modifier = (key, None) 210​ key, modifier = (key, None)
227 211​
228 if modifier == 'like': 212​ if modifier == 'like':
229 alias = db.aliased(ResultData) 213​ alias = db.aliased(ResultData)
230 if len(values) > 1: #multiple values 214​ if len(values) > 1: # multiple values
231 likes = [] 215​ likes = []
232 # create the (value LIKE foo OR value LIKE bar OR ...) part 216​ # create the (value LIKE foo OR value LIKE bar OR ...) part
233 for value in values: 217​ for value in values:
234 likes.append(alias.value.like(value)) 218​ likes.append(alias.value.like(value))
235 # put it together to (key = key AND (value LIKE foo OR value LIKE bar OR ...)) 219​ # put it together to (key = key AND (value LIKE foo OR value LIKE bar OR ...))
236 q = q.join(alias).filter(db.and_(alias.key == key, db.or_(*likes))) 220​ q = q.join(alias).filter(db.and_(alias.key == key, db.or_(*likes)))
237 else: 221​ else:
238 q = q.join(alias).filter(db.and_(alias.key == key, alias.value.like(values[0]))) 222​ q = q.join(alias).filter(
223​ db.and_(alias.key == key, alias.value.like(values[0])))
239 224​
240 else: 225​ else:
241 alias = db.aliased(ResultData) 226​ alias = db.aliased(ResultData)
242 q = q.join(alias).filter(db.and_(alias.key == key, alias.value.in_(values))) 227​ q = q.join(alias).filter(db.and_(alias.key == key, alias.value.in_(values)))
243 228​
244 return q 229​ return q
245 230​
246 231​
247# ============================================================================= 232​# =============================================================================
248# JOBS 233​# JOBS
249# ============================================================================= 234​# =============================================================================
250 235​
251RP['get_jobs'] = reqparse.RequestParser() 236​RP['get_jobs'] = reqparse.RequestParser()
252RP['get_jobs'].add_argument('page', default = 0, type = int, location = 'args') 237​RP['get_jobs'].add_argument('page', default=0, type=int, location='args')
253RP['get_jobs'].add_argument('limit', default = QUERY_LIMIT, type = int, location = 'args') 238​RP['get_jobs'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
254RP['get_jobs'].add_argument('since', default = None, type = str, location = 'args') 239​RP['get_jobs'].add_argument('since', default=None, type=str, location='args')
255RP['get_jobs'].add_argument('status', default = None, type = str, location = 'args') 240​RP['get_jobs'].add_argument('status', default=None, type=str, location='args')
256RP['get_jobs'].add_argument('name', default = None, type = str, location = 'args') 241​RP['get_jobs'].add_argument('name', default=None, type=str, location='args')
257RP['get_jobs'].add_argument('load_results', default = False, type = bool, location = 'args') 242​RP['get_jobs'].add_argument('load_results', default=False, type=bool, location='args')
258# These two are ignored. They're present so reqparse isn't confused by JSONP. 243​# These two are ignored. They're present so reqparse isn't confused by JSONP.
259RP['get_jobs'].add_argument('callback', type = str, location = 'args') 244​RP['get_jobs'].add_argument('callback', type=str, location='args')
260RP['get_jobs'].add_argument('_', type = str, location = 'args') 245​RP['get_jobs'].add_argument('_', type=str, location='args')
261 246​
262 247​
263RP['create_job'] = reqparse.RequestParser() 248​RP['create_job'] = reqparse.RequestParser()
264RP['create_job'].add_argument('ref_url', type = str, required = True, location = 'json') 249​RP['create_job'].add_argument('ref_url', type=str, required=True, location='json')
265RP['create_job'].add_argument('status', type = str, default = 'SCHEDULED', location = 'json') 250​RP['create_job'].add_argument('status', type=str, default='SCHEDULED', location='json')
266RP['create_job'].add_argument('name', type = str, default = None, location = 'json') 251​RP['create_job'].add_argument('name', type=str, default=None, location='json')
267RP['create_job'].add_argument('uuid', type = str, default = None, location = 'json') 252​RP['create_job'].add_argument('uuid', type=str, default=None, location='json')
268 253​
269RP['update_job'] = reqparse.RequestParser() 254​RP['update_job'] = reqparse.RequestParser()
270RP['update_job'].add_argument('status', type = str, required = True, location = 'json') 255​RP['update_job'].add_argument('status', type=str, required=True, location='json')
271RP['update_job'].add_argument('return_data', default = False, type = bool, location = 'args') 256​RP['update_job'].add_argument('return_data', default=False, type=bool, location='args')
272 257​
273 258​
274@api.route('/v1.0/jobs', methods = ['GET']) 259​@api.route('/jobs', methods=['GET'])
275def get_jobs(): #page = None, limit = QUERY_LIMIT): 260​def get_jobs(): # page = None, limit = QUERY_LIMIT):
276 try: 261​ try:
277 args = RP['get_jobs'].parse_args() 262​ args = RP['get_jobs'].parse_args()
278 except JSONBadRequest as error: 263​ except JSONBadRequest as error:
279 return jsonify({"message": "Malformed JSON data"}), error.code 264​ return jsonify({"message": "Malformed JSON data"}), error.code
280 except HTTPException as error: 265​ except HTTPException as error:
281 return jsonify(error.data), error.code 266​ return jsonify(error.data), error.code
282 267​
283 try: 268​ try:
284 s, e = parse_since(args['since']) 269​ s, e = parse_since(args['since'])
285 except iso8601.iso8601.ParseError: 270​ except iso8601.iso8601.ParseError:
286 return jsonify({"message": "'since' parameter not in ISO8601 format"}), 400 271​ return jsonify({"message": "'since' parameter not in ISO8601 format"}), 400
287 272​
288 if args['status'] is not None and args['status'] not in JOB_STATUS: 273​ if args['status'] is not None and args['status'] not in JOB_STATUS:
289 return jsonify({'message': "status must be one of %r" % (JOB_STATUS,) }), 400 274​ return jsonify({'message': "status must be one of %r" % (JOB_STATUS,)}), 400
290 275​
291 q = select_jobs(since_start = s, since_end = e, status = args['status'], name = args['name']) 276​ q = select_jobs(since_start=s, since_end=e, status=args['status'], name=args['name'])
292 277​
293 q = pagination(q, args['page'], args['limit']) 278​ q = pagination(q, args['page'], args['limit'])
294 prev, next = prev_next_urls() 279​ prev, next = prev_next_urls()
295 280​
296 return jsonify(dict( 281​ return jsonify(dict(
297 href=request.url, 282​ href=request.url,
298 prev=prev, 283​ prev=prev,
299 next=next, 284​ next=next,
300 data=[ 285​ data=[
301 SERIALIZE(o, job_load_results=args['load_results']) 286​ SERIALIZE(o, job_load_results=args['load_results'])
302 for o in q.all() 287​ for o in q.all()
303 ], 288​ ],
304 )) 289​ ))
305 290​
306@api.route('/v1.0/jobs/<job_id>', methods = ['GET']) 291​
292​@api.route('/jobs/<job_id>', methods=['GET'])
307def get_job(job_id): 293​def get_job(job_id):
308 try: 294​ try:
309 job_id = int(job_id) 295​ job_id = int(job_id)
310 except ValueError: # uuid can not be parsed to int 296​ except ValueError: # uuid can not be parsed to int
311 q = Job.query.filter_by(uuid = job_id) 297​ q = Group.query.filter_by(uuid=job_id)
312 else: # id was int -> filter by id 298​ else: # id was int -> filter by id
313 q = Job.query.filter_by(id = job_id) 299​ q = Group.query.filter_by(id=job_id)
314 300​
315 job = q.first() 301​ job = q.first()
316 if not job: 302​ if not job:
317 return jsonify({'message': "Job not found" }), 404 303​ return jsonify({'message': "1: Job not found"}), 404
318 304​
319 return jsonify(SERIALIZE(job)) 305​ return jsonify(SERIALIZE(job))
320 306​
321 307​
322@api.route('/v1.0/jobs', methods = ['POST']) 308​@api.route('/jobs', methods=['POST'])
323def create_job(): 309​def create_job():
324 try: 310​ try:
325 args = RP['create_job'].parse_args() 311​ args = RP['create_job'].parse_args()
326 except JSONBadRequest as error: 312​ except JSONBadRequest as error:
327 return jsonify({"message": "Malformed JSON data"}), error.code 313​ return jsonify({"message": "Malformed JSON data"}), error.code
328 except HTTPException as error: 314​ except HTTPException as error:
329 return jsonify(error.data), error.code 315​ return jsonify(error.data), error.code
330 316​
317​ if not args['iuuid']:
318​ args['uuid'] = str(uuid.uuid1())
331 319​
332 if args['status'] is not None and args['status'] not in JOB_STATUS: 320​ job = Group(args['uuid'], args['ref_url'], args['name'])
333 return jsonify({'message': "status must be one of %r" % (JOB_STATUS,) }), 400 ​
334 ​
335 if args['status'] is None: ​
336 args['status'] = 'SCHEDULED' ​
337 ​
338 job = Job(args['status'], args['ref_url'], args['name'], args['uuid']) ​
339 db.session.add(job) 321​ db.session.add(job)
340 db.session.commit() 322​ db.session.commit()
341 323​
342 db.session.add(job) 324​ db.session.add(job)
343 return jsonify(SERIALIZE(job)), 201 325​ return jsonify(SERIALIZE(job)), 201
344 326​
345@api.route('/v1.0/jobs/<job_id>', methods = ['PUT']) 327​
328​@api.route('/jobs/<job_id>', methods=['PUT'])
346def update_job(job_id): 329​def update_job(job_id):
347 try: 330​ try:
348 job_id = int(job_id) 331​ job_id = int(job_id)
349 except ValueError: # uuid can not be parsed to int 332​ except ValueError: # uuid can not be parsed to int
350 q = Job.query.filter_by(uuid = job_id) 333​ q = Group.query.filter_by(uuid=job_id)
351 else: # id was int -> filter by id 334​ else: # id was int -> filter by id
352 q = Job.query.filter_by(id = job_id) 335​ q = Group.query.filter_by(id=job_id)
353 336​
354 # Fail early, if the job does not exist 337​ # Fail early, if the job does not exist
355 try: 338​ try:
356 job = q.one() 339​ job = q.one()
357 except orm_exc.NoResultFound: 340​ except orm_exc.NoResultFound:
358 return jsonify({'message': "Job not found" }), 404 341​ return jsonify({'message': "2: Job not found"}), 404
359 342​
360 try: 343​ data = job
361 args = RP['update_job'].parse_args() ​
362 except JSONBadRequest as error: ​
363 return jsonify({"message": "Malformed JSON data"}), error.code ​
364 except HTTPException as error: ​
365 return jsonify(error.data), error.code ​
366 ​
367 new_status = args['status'].strip().upper() ​
368 if new_status not in JOB_STATUS: ​
369 return jsonify({'message': "status must be one of %r" % (JOB_STATUS,) }), 400 ​
370 ​
371 ​
372 # Side-effects based on status transitions ​
373 if job.start_time is None and job.status == 'SCHEDULED' and new_status == "RUNNING": ​
374 job.start_time = datetime.datetime.utcnow() ​
375 ​
376 if job.end_time is None and job.status == 'RUNNING' and new_status in ('COMPLETED', 'ABORTED', 'CRASHED', 'NEEDS_INSPECTION'): ​
377 job.end_time = datetime.datetime.utcnow() ​
378 ​
379 if job.status == "SCHEDULED" and new_status in ('COMPLETED', 'ABORTED', 'CRASHED', 'NEEDS_INSPECTION'): ​
380 if job.start_time is None: ​
381 job.start_time = datetime.datetime.utcnow() ​
382 if job.end_time is None: ​
383 job.end_time = datetime.datetime.utcnow() ​
384 ​
385 ​
386 job.status = new_status ​
387 db.session.add(job) ​
388 db.session.commit() ​
389 ​
390 data = {} ​
391 if args['return_data']: ​
392 data = job ​
393 344​
394 return jsonify(SERIALIZE(data)), 200 345​ return jsonify(SERIALIZE(data)), 200
395 346​
396 347​
397# ============================================================================= 348​# =============================================================================
398# RESULTS 349​# RESULTS
399# ============================================================================= 350​# =============================================================================
400 351​
401RP['get_results'] = reqparse.RequestParser() 352​RP['get_results'] = reqparse.RequestParser()
402RP['get_results'].add_argument('page', default = 0, type = int, location = 'args') 353​RP['get_results'].add_argument('page', default=0, type=int, location='args')
403RP['get_results'].add_argument('limit', default = QUERY_LIMIT, type = int, location = 'args') 354​RP['get_results'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
404RP['get_results'].add_argument('since', type = str, location = 'args') 355​RP['get_results'].add_argument('since', type=str, location='args')
405RP['get_results'].add_argument('since_source', type = str, default = 'result', location = 'args') 356​RP['get_results'].add_argument('since_source', type=str, default='result', location='args')
406RP['get_results'].add_argument('outcome', type = str, location = 'args') 357​RP['get_results'].add_argument('outcome', type=str, location='args')
407RP['get_results'].add_argument('job_id', type = str, location = 'args') 358​RP['get_results'].add_argument('job_id', type=str, location='args')
408RP['get_results'].add_argument('testcase_name', type = str, location = 'args') 359​RP['get_results'].add_argument('testcase_name', type=str, location='args')
409# These two are ignored. They're present so reqparse isn't confused by JSONP. 360​# These two are ignored. They're present so reqparse isn't confused by JSONP.
410RP['get_results'].add_argument('callback', type = str, location = 'args') 361​RP['get_results'].add_argument('callback', type=str, location='args')
411RP['get_results'].add_argument('_', type = str, location = 'args') 362​RP['get_results'].add_argument('_', type=str, location='args')
412 363​
413RP['create_result'] = reqparse.RequestParser() 364​RP['create_result'] = reqparse.RequestParser()
414RP['create_result'].add_argument('job_id', type = str, required = True, location = 'json') 365​RP['create_result'].add_argument('job_id', type=str, required=True, location='json')
415RP['create_result'].add_argument('outcome', type = str, required = True, location = 'json') 366​RP['create_result'].add_argument('outcome', type=str, required=True, location='json')
416RP['create_result'].add_argument('testcase_name', type = str, required = True, location = 'json') 367​RP['create_result'].add_argument('testcase_name', type=str, required=True, location='json')
417RP['create_result'].add_argument('summary', type = str, location = 'json') 368​RP['create_result'].add_argument('summary', type=str, location='json')
418RP['create_result'].add_argument('result_data', type = dict, location = 'json') 369​RP['create_result'].add_argument('result_data', type=dict, location='json')
419RP['create_result'].add_argument('log_url', type = str, location = 'json') 370​RP['create_result'].add_argument('log_url', type=str, location='json')
420RP['create_result'].add_argument('strict', type = bool, default=False, location = 'json') 371​RP['create_result'].add_argument('strict', type=bool, default=False, location='json')
421 372​
422 373​
423def __get_results_parse_args(): 374​def __get_results_parse_args():
424 retval = {"args": None, "error": None, "result_data": None} 375​ retval = {"args": None, "error": None, "result_data": None}
425 try: 376​ try:
426 args = RP['get_results'].parse_args() 377​ args = RP['get_results'].parse_args()
427 except JSONBadRequest as error: 378​ except JSONBadRequest as error:
428 retval["error"] = (jsonify({"message": "Malformed JSON data"}), error.code) 379​ retval["error"] = (jsonify({"message": "Malformed JSON data"}), error.code)
429 return retval 380​ return retval
430 except HTTPException as error: 381​ except HTTPException as error:
431 retval["error"] = (jsonify(error.data), error.code) 382​ retval["error"] = (jsonify(error.data), error.code)
432 return retval 383​ return retval
433 384​
434 if args['outcome'] is not None: 385​ if args['outcome'] is not None:
435 args['outcome'] = args['outcome'].strip().upper() 386​ args['outcome'] = args['outcome'].strip().upper()
436 if args['outcome'] not in RESULT_OUTCOME: 387​ if args['outcome'] not in RESULT_OUTCOME:
437 retval["error"] =(jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,) }), 400) 388​ retval["error"] = (
389​ jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,)}), 400)
438 return retval 390​ return retval
439 391​
440 try: 392​ try:
441 s, e = parse_since(args['since']) 393​ s, e = parse_since(args['since'])
442 except iso8601.iso8601.ParseError: 394​ except iso8601.iso8601.ParseError:
443 retval["error"] = (jsonify({"message": "'since' parameter not in ISO8601 format"}), 400) 395​ retval["error"] = (jsonify({"message": "'since' parameter not in ISO8601 format"}), 400)
444 return retval 396​ return retval
445 397​
446 args['since'] = {'start': s, 'end': e} 398​ args['since'] = {'start': s, 'end': e}
447 399​
448 args['since_source'] = args['since_source'].lower().strip() 400​ args['since_source'] = args['since_source'].lower().strip()
449 if args['since_source'] not in ('job', 'result'): 401​ if args['since_source'] not in ('job', 'result'):
450 retval['error'] = (jsonify({"message": "since_source has to be one of ('result', 'job'). Default = 'result'"}), 400) 402​ retval['error'] = (
403​ jsonify({"message": "since_source has to be one of ('result', 'job'). Default = 'result'"}), 400)
451 404​
452 retval['args'] = args 405​ retval['args'] = args
453 406​
454 # fill extra_data with the query parameters 'other' than those defined in RP['get_results'] 407​ # fill extra_data with the query parameters 'other' than those defined in RP['get_results']
455 # 408​ #
456 req_args = dict(request.args) # this is important, do not delete ;) 409​ req_args = dict(request.args) # this is important, do not delete ;)
457 extra_data = {k:req_args[k] for k in req_args if k not in args} 410​ extra_data = {k: req_args[k] for k in req_args if k not in args}
458 for k, v in extra_data.iteritems(): 411​ for k, v in extra_data.iteritems():
459 for i, s in enumerate(v): 412​ for i, s in enumerate(v):
460 extra_data[k][i] = s.split(',') 413​ extra_data[k][i] = s.split(',')
461 # flatten the list 414​ # flatten the list
462 extra_data[k] = [item for sublist in extra_data[k] for item in sublist] 415​ extra_data[k] = [item for sublist in extra_data[k] for item in sublist]
463 416​
464 if extra_data != {}: 417​ if extra_data != {}:
465 retval['result_data'] = extra_data 418​ retval['result_data'] = extra_data
466 419​
467 return retval 420​ return retval
468 421​
469 422​
470@api.route('/v1.0/results', methods = ['GET']) 423​@api.route('/results', methods=['GET'])
471def get_results(job_id = None, testcase_name = None): 424​def get_results(job_id=None, testcase_name=None):
472 425​
473 p = __get_results_parse_args() 426​ p = __get_results_parse_args()
474 if p['error'] is not None: 427​ if p['error'] is not None:
475 return p['error'] 428​ return p['error']
476 429​
477 args = p['args'] 430​ args = p['args']
478 431​
479 j_id = job_id if job_id is not None else args['job_id'] 432​ j_id = job_id if job_id is not None else args['job_id']
480 t_nm = testcase_name if testcase_name is not None else args['testcase_name'] 433​ t_nm = testcase_name if testcase_name is not None else args['testcase_name']
481 434​
482 ​
483 q = select_results( 435​ q = select_results(
484 since_start = args['since']['start'], 436​ since_start=args['since']['start'],
485 since_end = args['since']['end'], 437​ since_end=args['since']['end'],
486 since_source = args['since_source'], 438​ since_source=args['since_source'],
487 outcome = args['outcome'], 439​ outcome=args['outcome'],
488 result_data = p['result_data'], 440​ result_data=p['result_data'],
489 job_id = j_id, 441​ job_id=j_id,
490 testcase_name = t_nm, 442​ testcase_name=t_nm,
491 ) 443​ )
492 444​
493 q = pagination(q, args['page'], args['limit']) 445​ q = pagination(q, args['page'], args['limit'])
494 prev, next = prev_next_urls() 446​ prev, next = prev_next_urls()
495 447​
496 return jsonify(dict( 448​ return jsonify(dict(
497 href=request.url, 449​ href=request.url,
498 prev=prev, 450​ prev=prev,
499 next=next, 451​ next=next,
500 data=[SERIALIZE(o) for o in q.all()], 452​ data=[SERIALIZE(o) for o in q.all()],
501 )) 453​ ))
502 454​
503@api.route('/v1.0/jobs/<job_id>/results', methods = ['GET']) 455​
504@api.route('/v1.0/testcases/<testcase_name>/results', methods = ['GET']) 456​@api.route('/jobs/<job_id>/results', methods=['GET'])
505def get_results_by_job_testcase(job_id = None, testcase_name = None): 457​@api.route('/testcases/<testcase_name>/results', methods=['GET'])
458​def get_results_by_job_testcase(job_id=None, testcase_name=None):
506 # check whether the job/testcase exists. If not, throw 404 459​ # check whether the job/testcase exists. If not, throw 404
507 if job_id is not None: 460​ if job_id is not None:
508 try: 461​ try:
509 job_id = int(job_id) 462​ job_id = int(job_id)
510 except ValueError: # uuid can not be parsed to int 463​ except ValueError: # uuid can not be parsed to int
511 q = Job.query.filter_by(uuid = job_id) 464​ q = Group.query.filter_by(uuid=job_id)
512 else: # id was int -> filter by id 465​ else: # id was int -> filter by id
513 q = Job.query.filter_by(id = job_id) 466​ q = Group.query.filter_by(id=job_id)
514 467​
515 try: 468​ try:
516 job = Job.query.filter_by(id = job_id).one() 469​ job = q.one()
470​ job_id = job.uuid
517 except orm_exc.NoResultFound: 471​ except orm_exc.NoResultFound:
518 return jsonify({'message': "Job not found" }), 404 472​ return jsonify({'message': "3: Job not found: %s" % (job_id,)}), 404
519 473​
520 if testcase_name is not None: 474​ if testcase_name is not None:
521 try: 475​ try:
522 testcase = Testcase.query.filter_by(name = testcase_name).one() 476​ Testcase.query.filter_by(name=testcase_name).one()
523 except orm_exc.NoResultFound: 477​ except orm_exc.NoResultFound:
524 return jsonify({'message': "Testcase not found" }), 404 478​ return jsonify({'message': "Testcase not found"}), 404
525 479​
526 return get_results(job_id, testcase_name) 480​ return get_results(job_id, testcase_name)
527 481​
528 482​
529@api.route('/v1.0/results/<result_id>', methods = ['GET']) 483​@api.route('/results/<result_id>', methods=['GET'])
530def get_result(result_id): 484​def get_result(result_id):
531 try: 485​ try:
532 result = Result.query.filter_by(id = result_id).one() 486​ result = Result.query.filter_by(id=result_id).one()
533 except orm_exc.NoResultFound: 487​ except orm_exc.NoResultFound:
534 return jsonify({'message': "Result not found" }), 404 488​ return jsonify({'message': "Result not found"}), 404
535 489​
536 return jsonify(SERIALIZE(result)) 490​ return jsonify(SERIALIZE(result))
537 491​
538@api.route('/v1.0/results', methods = ['POST']) 492​
493​@api.route('/results', methods=['POST'])
539def create_result(): 494​def create_result():
540 try: 495​ try:
541 args = RP['create_result'].parse_args() 496​ args = RP['create_result'].parse_args()
542 except JSONBadRequest as error: 497​ except JSONBadRequest as error:
543 return jsonify({"message": "Malformed JSON data"}), error.code 498​ return jsonify({"message": "Malformed JSON data"}), error.code
544 except HTTPException as error: 499​ except HTTPException as error:
545 return jsonify(error.data), error.code 500​ return jsonify(error.data), error.code
546 501​
547 ​
548 try: 502​ try:
549 # since job_id is in the posted data here, get it from the processed 503​ # since job_id is in the posted data here, get it from the processed
550 # input args 504​ # input args
551 job_id = int(args['job_id']) 505​ job_id = int(args['job_id'])
552 except ValueError: # uuid can not be parsed to int 506​ except ValueError: # uuid can not be parsed to int
553 q = Job.query.filter_by(uuid = job_id) 507​ q = Group.query.filter_by(uuid=job_id)
554 else: # id was int -> filter by id 508​ else: # id was int -> filter by id
555 q = Job.query.filter_by(id = job_id) 509​ q = Group.query.filter_by(id=job_id)
556 510​
557 # Fail early, if the job does not exist 511​ # Fail early, if the job does not exist
558 try: 512​ try:
559 job = q.one() 513​ job = q.one()
560 except orm_exc.NoResultFound: 514​ except orm_exc.NoResultFound:
561 return jsonify({'message': "Job not found" }), 404 515​ return jsonify({'message': "4: Job not found"}), 404
562 ​
563 if job.status != 'RUNNING': ​
564 # Side-effects based on status transitions ​
565 if job.start_time is None or job.status == 'SCHEDULED': ​
566 job.start_time = datetime.datetime.utcnow() ​
567 job.status = 'RUNNING' ​
568 ​
569 if job.end_time: ​
570 job.end_time = datetime.datetime.utcnow() ​
571 516​
572 try: 517​ try:
573 testcase = Testcase.query.filter_by(name = args['testcase_name']).one() 518​ testcase = Testcase.query.filter_by(name=args['testcase_name']).one()
574 except orm_exc.NoResultFound: 519​ except orm_exc.NoResultFound:
575 if args['strict']: 520​ if args['strict']:
576 return jsonify({'message': "Testcase not found" }), 404 521​ return jsonify({'message': "Testcase not found"}), 404
577 else: 522​ else:
578 # TODO: add configurable default "empty" URL 523​ # TODO: add configurable default "empty" URL
579 testcase = Testcase(args['testcase_name'], "") 524​ testcase = Testcase(args['testcase_name'], "")
580 db.session.add(testcase) 525​ db.session.add(testcase)
581 db.session.commit() 526​ db.session.commit()
582 527​
583 outcome = args['outcome'].strip().upper() 528​ outcome = args['outcome'].strip().upper()
584 if outcome not in RESULT_OUTCOME: 529​ if outcome not in RESULT_OUTCOME:
585 return jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,) }), 400 530​ return jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,)}), 400
586 ​
587 ​
588 result = Result(job, testcase, outcome, args['log_url'], args['summary']) ​
589 531​
532​ result = Result(testcase, outcome, [job], args['log_url'], args['summary'])
590 533​
591 # Convert result_data 534​ # Convert result_data
592 # for each key-value pair in args['result_data'] 535​ # for each key-value pair in args['result_data']
593 # convert keys to unicode 536​ # convert keys to unicode
594 # if value is string: NOP 537​ # if value is string: NOP
595 # if value is list or tuple: convert values to unicode, create key-value pair for each value from the list 538​ # if value is list or tuple: convert values to unicode, create key-value pair for each value from the list
596 # if value is something else: convert to unicode 539​ # if value is something else: convert to unicode
597 # Store all the key-value pairs 540​ # Store all the key-value pairs
598 if args['result_data'] is not None: 541​ if args['result_data'] is not None:
599 to_store = [] 542​ to_store = []
600 for key, value in args['result_data'].items(): 543​ for key, value in args['result_data'].items():
601 if not (isinstance(key, str) or isinstance(key, unicode)): 544​ if not (isinstance(key, str) or isinstance(key, unicode)):
602 key = unicode(key) 545​ key = unicode(key)
603 546​
604 if (isinstance(value, str) or isinstance(value, unicode)): 547​ if (isinstance(value, str) or isinstance(value, unicode)):
605 to_store.append((key, value)) 548​ to_store.append((key, value))
606 549​
607 elif (isinstance(value, list) or isinstance(value, tuple)): 550​ elif (isinstance(value, list) or isinstance(value, tuple)):
608 for v in value: 551​ for v in value:
609 if not (isinstance(v, str) or isinstance(v, unicode)): 552​ if not (isinstance(v, str) or isinstance(v, unicode)):
610 v = unicode(v) 553​ v = unicode(v)
611 to_store.append((key, v)) 554​ to_store.append((key, v))
612 else: 555​ else:
613 value = unicode(value) 556​ value = unicode(value)
614 to_store.append((key, value)) 557​ to_store.append((key, value))
615 558​
616 for key, value in to_store: 559​ for key, value in to_store:
617 ResultData(result, key, value) 560​ ResultData(result, key, value)
618 561​
619 ​
620 db.session.add(result) 562​ db.session.add(result)
621 db.session.commit() 563​ db.session.commit()
622 564​
623 db.session.add(result) 565​ db.session.add(result)
624 566​
625 if app.config['FEDMSG_PUBLISH']: 567​ if app.config['FEDMSG_PUBLISH']:
626 prev_result = get_prev_result(result) 568​ prev_result = get_prev_result(result)
627 # result is considered duplicate of prev_result when 569​ # result is considered duplicate of prev_result when
Show All 12 Lines578def get_prev_result(result):
640 582​
641 Return None if no result is found. 583​ Return None if no result is found.
642 ''' 584​ '''
643 q = db.session.query(Result).filter(Result.id != result.id) 585​ q = db.session.query(Result).filter(Result.id != result.id)
644 586​
645 alias = db.aliased(Testcase) 587​ alias = db.aliased(Testcase)
646 q = q.join(alias).filter(alias.name == result.testcase.name) 588​ q = q.join(alias).filter(alias.name == result.testcase.name)
647 589​
648 for result_data in result.result_data: 590​ for result_data in result.data:
649 if result_data.key in ['item', 'arch']: 591​ if result_data.key in ['item', 'arch']:
650 alias = db.aliased(ResultData) 592​ alias = db.aliased(ResultData)
651 q = q.join(alias).filter(db.and_(alias.key == result_data.key, alias.value == result_data.value)) 593​ q = q.join(alias).filter(
594​ db.and_(alias.key == result_data.key, alias.value == result_data.value))
652 595​
653 q = q.order_by(db.desc(Result.submit_time)) 596​ q = q.order_by(db.desc(Result.submit_time))
654 597​
655 return q.first() 598​ return q.first()
656 599​
657 600​
658def create_fedmsg(result, prev_result=None): 601​def create_fedmsg(result, prev_result=None):
659 task = dict((result_data.key, result_data.value) for result_data in result.result_data 602​ task = dict((result_data.key, result_data.value) for result_data in result.data
660 if result_data.key in ['item', 'type']) 603​ if result_data.key in ['item', 'type'])
661 task['name'] = result.testcase.name 604​ task['name'] = result.testcase.name
662 return { 605​ return {
663 'topic': 'result.new', 606​ 'topic': 'result.new',
664 'modname': app.config['FEDMSG_MODNAME'], 607​ 'modname': app.config['FEDMSG_MODNAME'],
665 'msg': { 608​ 'msg': {
666 'task': task, 609​ 'task': task,
667 'result': { 610​ 'result': {
668 'id': result.id, 611​ 'id': result.id,
669 'submit_time': result.submit_time.strftime("%Y-%m-%d %H:%M:%S UTC"), 612​ 'submit_time': result.submit_time.strftime("%Y-%m-%d %H:%M:%S UTC"),
670 'prev_outcome': prev_result.outcome if prev_result else None, 613​ 'prev_outcome': prev_result.outcome if prev_result else None,
671 'outcome': result.outcome, 614​ 'outcome': result.outcome,
672 'job_url': result.job.ref_url, 615​ 'job_url': result.job.ref_url,
673 'log_url': result.log_url, 616​ 'log_url': result.ref_url,
674 } 617​ }
675 } 618​ }
676 } 619​ }
677 620​
678 621​
679# ============================================================================= 622​# =============================================================================
680# TESTCASES 623​# TESTCASES
681# ============================================================================= 624​# =============================================================================
682 625​
683RP['get_testcases'] = reqparse.RequestParser() 626​RP['get_testcases'] = reqparse.RequestParser()
684RP['get_testcases'].add_argument('page', default = 0, type = int, location = 'args') 627​RP['get_testcases'].add_argument('page', default=0, type=int, location='args')
685RP['get_testcases'].add_argument('limit', default = QUERY_LIMIT, type = int, location = 'args') 628​RP['get_testcases'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
686# These two are ignored. They're present so reqparse isn't confused by JSONP. 629​# These two are ignored. They're present so reqparse isn't confused by JSONP.
687RP['get_testcases'].add_argument('callback', type = str, location = 'args') 630​RP['get_testcases'].add_argument('callback', type=str, location='args')
688RP['get_testcases'].add_argument('_', type = str, location = 'args') 631​RP['get_testcases'].add_argument('_', type=str, location='args')
689 632​
690RP['create_testcase'] = reqparse.RequestParser() 633​RP['create_testcase'] = reqparse.RequestParser()
691RP['create_testcase'].add_argument('name', type = str, required = True, location = 'json') 634​RP['create_testcase'].add_argument('name', type=str, required=True, location='json')
692RP['create_testcase'].add_argument('url', type = str, required = False, location = 'json') 635​RP['create_testcase'].add_argument('url', type=str, required=False, location='json')
693 636​
694RP['update_testcase'] = reqparse.RequestParser() 637​RP['update_testcase'] = reqparse.RequestParser()
695RP['update_testcase'].add_argument('url', type = str, required = True, location = 'json') 638​RP['update_testcase'].add_argument('url', type=str, required=True, location='json')
696 639​
697 640​
698@api.route('/v1.0/testcases', methods = ['GET']) 641​@api.route('/testcases', methods=['GET'])
699def get_testcases(): #page = None, limit = QUERY_LIMIT): 642​def get_testcases(): # page = None, limit = QUERY_LIMIT):
700 643​
701 try: 644​ try:
702 args = RP['get_testcases'].parse_args() 645​ args = RP['get_testcases'].parse_args()
703 except JSONBadRequest as error: 646​ except JSONBadRequest as error:
704 return jsonify({"message": "Malformed JSON data"}), error.code 647​ return jsonify({"message": "Malformed JSON data"}), error.code
705 except HTTPException as error: 648​ except HTTPException as error:
706 return jsonify(error.data), error.code 649​ return jsonify(error.data), error.code
707 650​
708 ​
709 q = db.session.query(Testcase) 651​ q = db.session.query(Testcase)
710 q.order_by(db.asc(Testcase.name)) 652​ q.order_by(db.asc(Testcase.name))
711 653​
712 q = pagination(q, args['page'], args['limit']) 654​ q = pagination(q, args['page'], args['limit'])
713 prev, next = prev_next_urls() 655​ prev, next = prev_next_urls()
714 656​
715 return jsonify(dict( 657​ return jsonify(dict(
716 href=request.url, 658​ href=request.url,
717 prev=prev, 659​ prev=prev,
718 next=next, 660​ next=next,
719 data=[SERIALIZE(o) for o in q.all()], 661​ data=[SERIALIZE(o) for o in q.all()],
720 )) 662​ ))
721 663​
722@api.route('/v1.0/testcases/<testcase_name>', methods = ['GET']) 664​
665​@api.route('/testcases/<testcase_name>', methods=['GET'])
723def get_testcase(testcase_name): 666​def get_testcase(testcase_name):
724 667​
725 try: 668​ try:
726 testcase = Testcase.query.filter_by(name = testcase_name).one() 669​ testcase = Testcase.query.filter_by(name=testcase_name).one()
727 except orm_exc.NoResultFound: 670​ except orm_exc.NoResultFound:
728 return jsonify({'message': "Testcase not found" }), 404 671​ return jsonify({'message': "Testcase not found"}), 404
729 672​
730 return jsonify(SERIALIZE(testcase)) 673​ return jsonify(SERIALIZE(testcase))
731 674​
732 675​
733@api.route('/v1.0/testcases', methods = ['POST']) 676​@api.route('/testcases', methods=['POST'])
734def create_testcase(): 677​def create_testcase():
735 try: 678​ try:
736 args = RP['create_testcase'].parse_args() 679​ args = RP['create_testcase'].parse_args()
737 except JSONBadRequest as error: 680​ except JSONBadRequest as error:
738 return jsonify({"message": "Malformed JSON data"}), error.code 681​ return jsonify({"message": "Malformed JSON data"}), error.code
739 except HTTPException as error: 682​ except HTTPException as error:
740 return jsonify(error.data), error.code 683​ return jsonify(error.data), error.code
741 684​
742 testcase = Testcase(args['name'], args['url']) 685​ testcase = Testcase(args['name'], args['url'])
743 try: 686​ try:
744 db.session.add(testcase) 687​ db.session.add(testcase)
745 db.session.commit() 688​ db.session.commit()
746 except sqlalchemy_exc.IntegrityError as e: 689​ except sqlalchemy_exc.IntegrityError:
747 #return jsonify({"message": e.message}), 400 690​ # return jsonify({"message": e.message}), 400
748 return jsonify({"message": "Testcase with this name already exists"}), 400 691​ return jsonify({"message": "Testcase with this name already exists"}), 400
749 692​
750 db.session.add(testcase) 693​ db.session.add(testcase)
751 return jsonify(SERIALIZE(testcase)), 201 694​ return jsonify(SERIALIZE(testcase)), 201
752 695​
753@api.route('/v1.0/testcases/<testcase_name>', methods = ['PUT']) 696​
697​@api.route('/testcases/<testcase_name>', methods=['PUT'])
754def update_testcase(testcase_name): 698​def update_testcase(testcase_name):
755 # Fail early, if the job does not exist 699​ # Fail early, if the job does not exist
756 try: 700​ try:
757 tc = Testcase.query.filter_by(name = testcase_name).one() 701​ tc = Testcase.query.filter_by(name=testcase_name).one()
758 except orm_exc.NoResultFound: 702​ except orm_exc.NoResultFound:
759 return jsonify({'message': "Testcase not found" }), 404 703​ return jsonify({'message': "Testcase not found"}), 404
760 704​
761 try: 705​ try:
762 args = RP['update_testcase'].parse_args() 706​ args = RP['update_testcase'].parse_args()
763 except JSONBadRequest as error: 707​ except JSONBadRequest as error:
764 return jsonify({"message": "Malformed JSON data"}), error.code 708​ return jsonify({"message": "Malformed JSON data"}), error.code
765 except HTTPException as error: 709​ except HTTPException as error:
766 return jsonify(error.data), error.code 710​ return jsonify(error.data), error.code
767 711​
768 tc.url = args['url'] 712​ tc.ref_url = args['url']
769 db.session.add(tc) 713​ db.session.add(tc)
770 db.session.commit() 714​ db.session.commit()
771 715​
772 return jsonify(SERIALIZE(tc)), 200 716​ return jsonify(SERIALIZE(tc)), 200
773 717​
718​
719​@api.route('', methods=['GET'])
774@api.route('/', methods=['GET']) 720​@api.route('/', methods=['GET'])
775@api.route('/v1.0', methods=['GET']) ​
776@api.route('/v1.0/', methods=['GET']) ​
777def landing_page(): 721​def landing_page():
778 return jsonify({"message": "Everything is fine. But choose wisely, for while " 722​ return jsonify({"message": "Everything is fine. But choose wisely, for while "
779 "the true Grail will bring you life, the false " 723​ "the true Grail will bring you life, the false "
780 "Grail will take it from you.", 724​ "Grail will take it from you.",
781 "documentation": "http://docs.resultsdb.apiary.io/", 725​ "documentation": "http://docs.resultsdb.apiary.io/",
782 "jobs": url_for('.get_jobs', _external=True), 726​ "jobs": url_for('.get_jobs', _external=True),
783 "results": url_for('.get_results', _external=True), 727​ "results": url_for('.get_results', _external=True),
784 "testcases": url_for('.get_testcases', _external=True) 728​ "testcases": url_for('.get_testcases', _external=True)
785 }), 300 729​ }), 300
View Options

resultsdb/controllers/api_v2.py

  • This file was added.
1​# Copyright 2013-2016, Red Hat, Inc
2​#
3​# This program is free software; you can redistribute it and/or modify
4​# it under the terms of the GNU General Public License as published by
5​# the Free Software Foundation; either version 2 of the License, or
6​# (at your option) any later version.
7​#
8​# This program is distributed in the hope that it will be useful,
9​# but WITHOUT ANY WARRANTY; without even the implied warranty of
10​# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11​# GNU General Public License for more details.
12​#
13​# You should have received a copy of the GNU General Public License along
14​# with this program; if not, write to the Free Software Foundation, Inc.,
15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16​#
17​# Authors:
18​# Josef Skladanka <jskladan@redhat.com>
19​# Ralph Bean <rbean@redhat.com>
20​
21​import re
22​import uuid
23​
24​from flask import Blueprint, jsonify, request, url_for
25​from flask.ext.restful import reqparse
26​
27​from sqlalchemy.orm import exc as orm_exc
28​from werkzeug.exceptions import HTTPException
29​
30​
31​from werkzeug.exceptions import BadRequest as JSONBadRequest
32​
33​import iso8601
34​import fedmsg
35​
36​from resultsdb import app, db
37​from resultsdb.serializers.api_v2 import Serializer
38​from resultsdb.models.results import Group, Result, Testcase, ResultData
39​from resultsdb.models.results import RESULT_OUTCOME
40​
41​QUERY_LIMIT = 20
42​
43​api = Blueprint('api_v2', __name__)
44​
45​# TODO: find out why error handler works for 404 but not for 400
46​
47​
48​@app.errorhandler(400)
49​def bad_request(error):
50​ return jsonify({"message": "Bad request"}), 400
51​
52​
53​@app.errorhandler(404)
54​def not_found(error):
55​ return jsonify({"message": "Not found"}), 404
56​
57​# =============================================================================
58​# GLOBAL VARIABLES
59​# =============================================================================
60​
61​RE_PAGE = re.compile(r"([?&])page=([0-9]+)")
62​
63​# RP contains request parsers (reqparse.RequestParser).
64​# Parsers are added in each 'resource section' for better readability
65​RP = {}
66​
67​SERIALIZE = Serializer().serialize
68​
69​# =============================================================================
70​# GLOBAL METHODS
71​# =============================================================================
72​
73​
74​def dict_or_string_type(value, *args, **kwargs):
75​ if args or kwargs:
76​ raise TypeError("Unexpected arguments")
77​ if isinstance(value, dict):
78​ return value
79​ if isinstance(value, basestring):
80​ return value
81​ raise ValueError("Expected dict or string, got %r" % type(value))
82​
83​
84​def list_or_none_type(value, *args, **kwargs):
85​ if args or kwargs:
86​ raise TypeError("Unexpected arguments")
87​ if isinstance(value, list):
88​ return value
89​ if value is None:
90​ return value
91​ raise ValueError("Expected list or None, got %r" % type(value))
92​
93​
94​def pagination(q, page, limit):
95​ """
96​ Sets the offset/limit for the DB query.
97​ limit+1 is purposely set as 'limit' so we can later on decide whether 'next'
98​ page link should be provided or set to None.
99​ """
100​ # pagination offset
101​ try:
102​ page = int(page)
103​ if page > 0:
104​ offset = page * limit
105​ q = q.offset(offset)
106​ except (TypeError, ValueError):
107​ pass
108​
109​ q = q.limit(limit + 1)
110​ return q
111​
112​
113​def prev_next_urls(data, limit=QUERY_LIMIT):
114​ global RE_PAGE
115​
116​ try:
117​ match = RE_PAGE.findall(request.url)
118​ flag, page = match[0][0], int(match[0][1])
119​ except IndexError: # page not found
120​ page = None
121​
122​ prev = None
123​ next = None
124​ placeholder = "[!@#$%^&*PLACEHOLDER*&^%$#@!]"
125​
126​ if not page:
127​ baseurl = "%s?page=%s" % (request.url, placeholder)
128​ page = 0
129​ else:
130​ baseurl = RE_PAGE.sub("%spage=%s" % (flag, placeholder), request.url)
131​
132​ if page > 0:
133​ prev = baseurl.replace(placeholder, str(page - 1))
134​ if len(data) > limit:
135​ next = baseurl.replace(placeholder, str(page + 1))
136​ data = data[:limit]
137​
138​ return data, prev, next
139​
140​
141​def parse_since(since):
142​ since_start = None
143​ since_end = None
144​ if since is not None:
145​ s = since.split(',')
146​ since_start = iso8601.parse_date(s[0])
147​ try:
148​ since_start = since_start.replace(tzinfo=None) # we need to strip timezone info
149​ since_end = iso8601.parse_date(s[1])
150​ since_end = since_end.replace(tzinfo=None) # we need to strip timezone info
151​ # Yes, this library sucks in Exception handling..
152​ except IndexError:
153​ pass
154​ except (TypeError, ValueError, iso8601.iso8601.ParseError):
155​ raise iso8601.iso8601.ParseError()
156​ return since_start, since_end
157​
158​
159​# =============================================================================
160​# GROUPS
161​# =============================================================================
162​
163​
164​RP['get_groups'] = reqparse.RequestParser()
165​RP['get_groups'].add_argument('page', default=0, type=int, location='args')
166​RP['get_groups'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
167​RP['get_groups'].add_argument('uuid', default=None, type=str, location='args')
168​RP['get_groups'].add_argument('description', default=None, type=str, location='args')
169​RP['get_groups'].add_argument('description:like', default=None, type=str, location='args')
170​# These two are ignored. They're present so reqparse isn't confused by JSONP.
171​RP['get_groups'].add_argument('callback', type=str, location='args')
172​RP['get_groups'].add_argument('_', type=str, location='args')
173​
174​
175​@api.route('/groups', methods=['GET'])
176​def get_groups():
177​ try:
178​ args = RP['get_groups'].parse_args()
179​ except JSONBadRequest as error:
180​ return jsonify({"message": "Malformed Request"}), error.code
181​ except HTTPException as error:
182​ return jsonify(error.data), error.code
183​
184​ q = db.session.query(Group).order_by(db.desc(Group.id))
185​
186​ desc_filters = []
187​ if args['description']:
188​ for description in args['description'].split(','):
189​ if not description.strip():
190​ continue
191​ desc_filters.append(Group.description == description)
192​# desc_filters.append(Group.description.in_(args['description'].split(',')))
193​ elif args['description:like']:
194​ for description in args['description:like'].split(','):
195​ if not description.strip():
196​ continue
197​ desc_filters.append(Group.description.like(description.replace("*", "%")))
198​ if desc_filters:
199​ q = q.filter(db.or_(*desc_filters))
200​ print q
201​
202​ # Filter by uuid
203​ if args['uuid']:
204​ q = q.filter(Group.uuid.in_(args['uuid'].split(',')))
205​
206​ q = pagination(q, args['page'], args['limit'])
207​ data, prev, next = prev_next_urls(q.all(), args['limit'])
208​
209​ return jsonify(dict(
210​ prev=prev,
211​ next=next,
212​ data=[SERIALIZE(o) for o in data],
213​ ))
214​
215​
216​@api.route('/groups/<group_id>', methods=['GET'])
217​def get_group(group_id):
218​ q = Group.query.filter_by(uuid=group_id)
219​ group = q.first()
220​ if not group:
221​ return jsonify({'message': "Group not found"}), 404
222​
223​ return jsonify(SERIALIZE(group))
224​
225​
226​RP['create_group'] = reqparse.RequestParser()
227​RP['create_group'].add_argument('uuid', type=str, default=None, location='json')
228​RP['create_group'].add_argument('ref_url', type=str, location='json')
229​RP['create_group'].add_argument('description', type=str, default=None, location='json')
230​
231​
232​@api.route('/groups', methods=['POST'])
233​def create_group():
234​ try:
235​ args = RP['create_group'].parse_args()
236​ except JSONBadRequest as error:
237​ return jsonify({"message": "Malformed Request"}), error.code
238​ except HTTPException as error:
239​ return jsonify(error.data), error.code
240​
241​ if args['uuid']:
242​ group = Group.query.filter_by(uuid=args['uuid']).first()
243​ if not group:
244​ group = Group(uuid=args['uuid'])
245​ else:
246​ group = Group(uuid=str(uuid.uuid1()))
247​
248​ if args['ref_url']:
249​ group.ref_url = args['ref_url']
250​ if args['description']:
251​ group.description = args['description']
252​
253​ db.session.add(group)
254​ db.session.commit()
255​
256​ db.session.add(group)
257​ return jsonify(SERIALIZE(group)), 201
258​
259​
260​# =============================================================================
261​# RESULTS
tflinkUnsubmitted
Not Done

If this is all commented out, can it be removed?

jskladanAuthorUnsubmitted
Not Done

Sure thing, /me just missed it.

262​# =============================================================================
263​
264​def select_results(since_start=None, since_end=None, outcomes=None, groups=None, testcases=None, testcases_like=None, result_data=None):
265​ q = db.session.query(Result).order_by(db.desc(Result.submit_time))
266​
267​ # Time constraints
268​ if since_start:
269​ q = q.filter(Result.submit_time >= since_start)
270​ if since_end:
271​ q = q.filter(Result.submit_time <= since_end)
272​
273​ # Filter by outcome
274​ if outcomes:
275​ q = q.filter(Result.outcome.in_(outcomes))
276​
277​ # Filter by group_id
278​ if groups:
279​ q = q.filter(Result.groups.any(Group.uuid.in_(groups)))
280​
281​ # Filter by testcase_name
282​ filter_by_testcase = []
283​ if testcases:
284​ filter_by_testcase.append(Result.testcase_name.in_(testcases))
285​ if testcases_like:
286​ for testcase in testcases_like:
287​ testcase = testcase.replace('*', '%')
288​ filter_by_testcase.append(Result.testcase_name.like(testcase))
289​ if filter_by_testcase:
290​ q = q.filter(db.or_(*filter_by_testcase))
291​
292​ # Filter by result_data
293​ if result_data is not None:
294​ for key, values in result_data.iteritems():
295​ try:
296​ key, modifier = key.split(':')
297​ except ValueError: # no : in key
298​ key, modifier = (key, None)
299​
300​ if modifier == 'like':
301​ alias = db.aliased(ResultData)
302​ if len(values) > 1: # multiple values
303​ likes = []
304​ # create the (value LIKE foo OR value LIKE bar OR ...) part
305​ for value in values:
306​ value = value.replace("*", "%")
307​ likes.append(alias.value.like(value))
308​ # put it together to (key = key AND (value LIKE foo OR value LIKE bar OR ...))
309​ q = q.join(alias).filter(db.and_(alias.key == key, db.or_(*likes)))
310​ else:
311​ value = values[0].replace('*', '%')
312​ q = q.join(alias).filter(db.and_(alias.key == key, alias.value.like(value)))
313​
314​ else:
315​ alias = db.aliased(ResultData)
316​ q = q.join(alias).filter(db.and_(alias.key == key, alias.value.in_(values)))
317​ return q
318​
319​
320​def __get_results_parse_args():
321​ retval = {"args": None, "error": None, "result_data": None}
322​ try:
323​ args = RP['get_results'].parse_args()
324​ except JSONBadRequest as error:
325​ retval["error"] = (jsonify({"message": "Malformed Request"}), error.code)
326​ return retval
327​ except HTTPException as error:
328​ retval["error"] = (jsonify(error.data), error.code)
329​ return retval
330​
331​ if args.get('outcome', None) is not None:
332​ args['outcome'] = [outcome.strip().upper() for outcome in args['outcome'].split(',')]
333​ for outcome in args['outcome']:
334​ if outcome not in RESULT_OUTCOME:
335​ retval["error"] = (
336​ jsonify({'message': "outcome %r not one of %r" % (outcome, RESULT_OUTCOME,)}), 400)
337​ return retval
338​
339​ try:
340​ s, e = parse_since(args.get('since', None))
341​ except iso8601.iso8601.ParseError:
342​ retval["error"] = (jsonify({"message": "'since' parameter not in ISO8601 format"}), 400)
343​ return retval
344​
345​ args['since'] = {'start': s, 'end': e}
346​ args['testcases'] = [tc.strip() for tc in args['testcases'].split(',') if tc.strip()]
347​ args['testcases:like'] = [tc.strip() for tc in args['testcases:like'].split(',') if tc.strip()]
348​ args['groups'] = [group.strip() for group in args['groups'].split(',') if group.strip()]
349​ retval['args'] = args
350​
351​ # find results_data with the query parameters
352​ # these are the paramters other than those defined in RequestParser
353​ req_args = dict(request.args) # this is important, do not delete ;)
354​
355​ # req_args is a dict of lists, where keys are param names and values are param values
356​ # the value is a list even if only one param value was specified
357​ results_data = {key: req_args[key] for key in req_args.iterkeys() if key not in args}
358​ for param, values in results_data.iteritems():
359​ for i, value in enumerate(values):
360​ results_data[param][i] = value.split(',')
361​ # flatten the list
362​ results_data[param] = [item for sublist in results_data[param] for item in sublist]
363​
364​ if results_data != {}:
365​ retval['result_data'] = results_data
366​
367​ return retval
368​
369​RP['get_results_latest'] = reqparse.RequestParser()
370​RP['get_results_latest'].add_argument('since', type=str, location='args')
371​RP['get_results_latest'].add_argument('groups', type=str, default="", location='args')
372​# TODO - can this be done any better?
373​RP['get_results_latest'].add_argument('testcases', type=str, default="", location='args')
374​RP['get_results_latest'].add_argument('testcases:like', type=str, default="", location='args')
375​# These two are ignored. They're present so reqparse isn't confused by JSONP.
376​RP['get_results_latest'].add_argument('callback', type=str, location='args')
377​RP['get_results_latest'].add_argument('_', type=str, location='args')
378​
379​
380​@api.route('/results/latest', methods=['GET'])
381​def get_results_latest():
382​ p = __get_results_parse_args()
383​ if p['error'] is not None:
384​ return p['error']
385​
386​ args = p['args']
387​ q = select_testcases(','.join(args['testcases']), ','.join(args['testcases:like']))
388​ testcases = q.all()
389​
390​ results = []
391​ for testcase in testcases:
392​ q = select_results(
393​ since_start=args['since']['start'],
394​ since_end=args['since']['end'],
395​ groups=args['groups'],
396​ testcases=[testcase.name],
397​ result_data=p['result_data'],
398​ )
399​ result = q.first()
400​ if result:
401​ results.append(result)
402​
403​ return jsonify(dict(
404​ data=[SERIALIZE(o) for o in results],
405​ ))
406​
407​
408​RP['get_results'] = reqparse.RequestParser()
409​RP['get_results'].add_argument('page', default=0, type=int, location='args')
410​RP['get_results'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
411​RP['get_results'].add_argument('since', type=str, location='args')
412​RP['get_results'].add_argument('outcome', type=str, location='args')
413​RP['get_results'].add_argument('groups', type=str, default="", location='args')
414​# TODO - can this be done any better?
415​RP['get_results'].add_argument('testcases', type=str, default="", location='args')
416​RP['get_results'].add_argument('testcases:like', type=str, default="", location='args')
417​# These two are ignored. They're present so reqparse isn't confused by JSONP.
418​RP['get_results'].add_argument('callback', type=str, location='args')
419​RP['get_results'].add_argument('_', type=str, location='args')
420​
421​
422​@api.route('/results', methods=['GET'])
423​def get_results(group_ids=None, testcase_names=None):
424​
425​ p = __get_results_parse_args()
426​ if p['error'] is not None:
427​ return p['error']
428​
429​ args = p['args']
430​
431​ groups = group_ids if group_ids is not None else args['groups']
432​ testcases = testcase_names if testcase_names is not None else args['testcases']
433​
434​ q = select_results(
435​ since_start=args['since']['start'],
436​ since_end=args['since']['end'],
437​ outcomes=args['outcome'],
438​ groups=groups,
439​ testcases=testcases,
440​ testcases_like=args['testcases:like'],
441​ result_data=p['result_data'],
442​ )
443​
444​ q = pagination(q, args['page'], args['limit'])
445​ data, prev, next = prev_next_urls(q.all(), args['limit'])
446​
447​ return jsonify(dict(
448​ prev=prev,
449​ next=next,
450​ data=[SERIALIZE(o) for o in data],
451​ ))
452​
453​
454​@api.route('/groups/<group_id>/results', methods=['GET'])
455​@api.route('/testcases/<testcase_name>/results', methods=['GET'])
456​def get_results_by_group_testcase(group_id=None, testcase_name=None):
457​ # check whether the group/testcase exists. If not, throw 404
458​ if group_id is not None:
459​ group = Group.query.filter_by(uuid=group_id).first()
460​ if not group:
461​ return jsonify({'message': "Group not found: %s" % (group_id,)}), 404
462​ group_id = [group.uuid]
463​
464​ if testcase_name is not None:
465​ testcase = Testcase.query.filter_by(name=testcase_name).first()
466​ if not testcase:
467​ return jsonify({'message': "Testcase not found"}), 404
468​ testcase_name = [testcase.name]
469​
470​ return get_results(group_id, testcase_name)
471​
472​
473​@api.route('/results/<result_id>', methods=['GET'])
474​def get_result(result_id):
475​ try:
476​ result = Result.query.filter_by(id=result_id).one()
477​ except orm_exc.NoResultFound:
478​ return jsonify({'message': "Result not found"}), 404
479​
480​ return jsonify(SERIALIZE(result))
481​
482​
483​RP['create_result'] = reqparse.RequestParser()
484​RP['create_result'].add_argument('outcome', type=str, required=True, location='json')
485​RP['create_result'].add_argument(
486​ 'testcase', type=dict_or_string_type, required=True, location='json')
487​RP['create_result'].add_argument('groups', type=list_or_none_type, location='json')
488​RP['create_result'].add_argument('note', type=str, location='json')
489​RP['create_result'].add_argument('data', type=dict, location='json')
490​RP['create_result'].add_argument('ref_url', type=str, location='json')
491​
492​
493​@api.route('/results', methods=['POST'])
494​def create_result():
495​ try:
tflinkUnsubmitted
Not Done

Is this documented anywhere?

jskladanAuthorUnsubmitted
Not Done

The fact, and reasoning is stated in the docs: http://docs.resultsdb20.apiary.io/#reference/0/results/create-new-result (see the data section), but if you can think of a better place, I'm all for it.

496​ args = RP['create_result'].parse_args()
497​ except JSONBadRequest as error:
498​ return jsonify({"message": "Malformed Request"}), error.code
499​ except HTTPException as error:
500​ return jsonify(error.data), error.code
501​
502​ outcome = args['outcome'].strip().upper()
503​ if outcome not in RESULT_OUTCOME:
504​ return jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,)}), 400
505​
506​ if args['data']:
507​ invalid_keys = [key for key in args['data'].iterkeys() if ':' in key]
508​ if invalid_keys:
509​ return jsonify({'message': "Colon not allowed in key name: %r" % invalid_keys}), 400
510​
511​ # args[testcase] can be either string or object
512​ # non-existing testcases are created automatically
513​ tc = args['testcase']
514​ if isinstance(tc, basestring):
515​ tc = dict(name=args['testcase'])
516​ elif isinstance(tc, dict) and 'name' not in tc:
517​ return jsonify({'message': "testcase.name not set"}), 400
518​
519​ testcase = Testcase.query.filter_by(name=tc['name']).first()
520​ if not testcase:
521​ testcase = Testcase(name=tc['name'])
522​ testcase.ref_url = tc.get('ref_url', testcase.ref_url)
523​ db.session.add(testcase)
524​ db.session.commit()
525​
526​ # args[groups] is a list of strings(uuid) or dicts(group object)
527​ # when a group defined by the string is not found, new is created
528​ # group defined by the object, is updated/created with the values from the object
529​ # non-existing groups are created automatically
530​ groups = []
531​ if args['groups']:
532​ for grp in args['groups']:
533​ if isinstance(grp, basestring):
534​ grp = dict(uuid=grp)
535​ elif isinstance(grp, dict):
536​ grp['uuid'] = grp.get('uuid', str(uuid.uuid1()))
537​
538​ group = Group.query.filter_by(uuid=grp['uuid']).first()
539​ if not group:
540​ group = Group(uuid=grp['uuid'])
541​
542​ group.description = grp.get('description', group.description)
543​ group.ref_url = grp.get('ref_url', group.ref_url)
544​
545​ db.session.add(group)
546​ db.session.commit()
547​ groups.append(group)
548​
549​ result = Result(testcase, outcome, groups, args['ref_url'], args['note'])
550​ # Convert result_data
551​ # for each key-value pair in args['data']
552​ # convert keys to unicode
553​ # if value is string: NOP
554​ # if value is list or tuple: convert values to unicode, create key-value pair for each value from the list
555​ # if value is something else: convert to unicode
556​ # Store all the key-value pairs
557​ if isinstance(args['data'], dict):
558​ to_store = []
559​ for key, value in args['data'].items():
560​ if not (isinstance(key, str) or isinstance(key, unicode)):
561​ key = unicode(key)
562​
563​ if (isinstance(value, str) or isinstance(value, unicode)):
564​ to_store.append((key, value))
565​
566​ elif (isinstance(value, list) or isinstance(value, tuple)):
567​ for v in value:
568​ if not (isinstance(v, str) or isinstance(v, unicode)):
569​ v = unicode(v)
570​ to_store.append((key, v))
571​ else:
572​ value = unicode(value)
573​ to_store.append((key, value))
574​
575​ for key, value in to_store:
576​ ResultData(result, key, value)
577​
578​ db.session.add(result)
579​ db.session.commit()
580​
581​ db.session.add(result)
582​
583​ if app.config['FEDMSG_PUBLISH']:
584​ fedmsg.publish(**create_fedmsg(result))
585​
586​ return jsonify(SERIALIZE(result)), 201
587​
588​
589​def get_prev_result(result):
590​ """
591​ Find previous result with the same testcase, item, type, and arch.
592​ Return None if no result is found.
593​ """
594​ q = db.session.query(Result).filter(Result.id != result.id)
595​ q = q.filter_by(testcase_name=result.testcase_name)
596​
597​ for result_data in result.data:
598​ if result_data.key in ['item', 'type', 'arch']:
599​ alias = db.aliased(ResultData)
600​ q = q.join(alias).filter(
601​ db.and_(alias.key == result_data.key, alias.value == result_data.value))
602​
603​ q = q.order_by(db.desc(Result.submit_time))
604​ return q.first()
605​
606​
607​def create_fedmsg(result):
608​ prev_result = get_prev_result(result)
609​ if prev_result and prev_result.outcome == result.outcome:
610​ return
611​
612​ task = dict((result_data.key, result_data.value) for result_data in result.data
613​ if result_data.key in ['item', 'type'])
614​ task['name'] = result.testcase.name
615​ msg = {
616​ 'topic': 'result.new',
617​ 'modname': app.config['FEDMSG_MODNAME'],
618​ 'msg': {
619​ 'task': task,
620​ 'result': {
621​ 'id': result.id,
622​ 'submit_time': result.submit_time.strftime("%Y-%m-%d %H:%M:%S UTC"),
623​ 'prev_outcome': prev_result.outcome if prev_result else None,
624​ 'outcome': result.outcome,
625​ 'group_url': result.group.ref_url,
626​ 'log_url': result.ref_url,
627​ }
628​ }
629​ }
630​ return msg
631​
632​
633​# =============================================================================
634​# TESTCASES
635​# =============================================================================
636​
637​def select_testcases(args_name=None, args_name_like=None):
638​ q = db.session.query(Testcase).order_by(db.asc(Testcase.name))
639​
640​ name_filters = []
641​ if args_name:
642​ for name in [name.strip() for name in args_name.split(',') if name.strip()]:
643​ name_filters.append(Testcase.name == name)
644​ elif args_name_like:
645​ for name in [name.strip() for name in args_name_like.split(',') if name.strip()]:
646​ name_filters.append(Testcase.name.like(name.replace("*", "%")))
647​ if name_filters:
648​ q = q.filter(db.or_(*name_filters))
649​
650​ return q
651​
652​
653​RP['get_testcases'] = reqparse.RequestParser()
654​RP['get_testcases'].add_argument('page', default=0, type=int, location='args')
655​RP['get_testcases'].add_argument('limit', default=QUERY_LIMIT, type=int, location='args')
656​RP['get_testcases'].add_argument('name', type=str, location='args')
657​RP['get_testcases'].add_argument('name:like', type=str, location='args')
658​# These two are ignored. They're present so reqparse isn't confused by JSONP.
659​RP['get_testcases'].add_argument('callback', type=str, location='args')
660​RP['get_testcases'].add_argument('_', type=str, location='args')
661​
662​
663​@api.route('/testcases', methods=['GET'])
664​def get_testcases(): # page = None, limit = QUERY_LIMIT):
665​
666​ try:
667​ args = RP['get_testcases'].parse_args()
668​ except JSONBadRequest as error:
669​ return jsonify({"message": "Malformed Request"}), error.code
670​ except HTTPException as error:
671​ return jsonify(error.data), error.code
672​
673​ q = select_testcases(args['name'], args['name:like'])
674​ q = pagination(q, args['page'], args['limit'])
675​ data, prev, next = prev_next_urls(q.all(), args['limit'])
676​
677​ return jsonify(dict(
678​ prev=prev,
679​ next=next,
680​ data=[SERIALIZE(o) for o in data],
681​ ))
682​
683​
684​@api.route('/testcases/<testcase_name>', methods=['GET'])
685​def get_testcase(testcase_name):
686​ try:
687​ testcase = Testcase.query.filter_by(name=testcase_name).one()
688​ except orm_exc.NoResultFound:
689​ return jsonify({'message': "Testcase not found"}), 404
690​
691​ return jsonify(SERIALIZE(testcase))
692​
693​
694​RP['create_testcase'] = reqparse.RequestParser()
695​RP['create_testcase'].add_argument('name', type=str, required=True, location='json')
696​RP['create_testcase'].add_argument('ref_url', type=str, required=False, location='json')
697​
698​
699​@api.route('/testcases', methods=['POST'])
700​def create_testcase():
701​ try:
702​ args = RP['create_testcase'].parse_args()
tflinkUnsubmitted
Not Done

Same question as above - if this is commented out, can it be removed entirely?

jskladanAuthorUnsubmitted
Not Done

Sure, /me just forgot to do it.

703​ except JSONBadRequest as error:
704​ return jsonify({"message": "Malformed Request"}), error.code
705​ except HTTPException as error:
706​ return jsonify(error.data), error.code
707​
708​ testcase = Testcase.query.filter_by(name=args['name']).first()
709​ if not testcase:
710​ testcase = Testcase(name=args['name'])
711​ if args['ref_url'] is not None:
712​ testcase.ref_url = args['ref_url']
713​
714​ db.session.add(testcase)
715​ db.session.commit()
716​
717​ db.session.add(testcase)
718​ return jsonify(SERIALIZE(testcase)), 201
719​
720​
721​@api.route('', methods=['GET'])
722​@api.route('/', methods=['GET'])
723​def landing_page():
724​ return jsonify({"message": "Everything is fine. But choose wisely, for while "
725​ "the true Grail will bring you life, the false "
726​ "Grail will take it from you.",
727​ "documentation": "http://docs.resultsdb20.apiary.io/",
728​ "groups": url_for('.get_groups', _external=True),
729​ "results": url_for('.get_results', _external=True),
730​ "testcases": url_for('.get_testcases', _external=True)
731​ }), 300
View Options

resultsdb/controllers/login_page.py

Loading...
View Options

resultsdb/controllers/main.py

Loading...
View Options

resultsdb/models/__init__.py

Loading...
View Options

resultsdb/models/results.py

Loading...
View Options

resultsdb/models/user.py

Loading...
View Options

resultsdb/proxy.py

Loading...
View Options

resultsdb/serializers/__init__.py

Loading...
View Options

resultsdb/serializers/api_v1.py

Loading...
View Options

resultsdb/serializers/api_v2.py

Loading...
View Options

run_cli.py

Loading...
View Options

setup.py

Loading...
View Options

testing/conftest.py

Loading...
View Options

testing/functest_api.py

Loading...
View Options

testing/functest_api_v20.py

Loading...
View Options

testing/functest_create_fedmsg.py

Loading...
View Options

testing/functest_duplicate_result.py

Loading...
View Options

testing/test_helpers.py

Loading...