Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup / simplify api version definition and usage #282

Merged
merged 1 commit into from
Apr 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
NOTICE

Synse v2.0
Synse v3.0
Copyright (c) 2015-2019 Vapor IO, Inc. and Synse contributors.

The following is courtesy of our legal counsel:
Expand Down
3 changes: 2 additions & 1 deletion synse_server/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"""

__title__ = 'synse_server'
__version__ = '2.2.8'
__version__ = '3.0.0'
__api_version__ = 'v3'
__description__ = 'An API to monitor and control physical and virtual devices.'
__author__ = 'Vapor IO'
__author_email__ = 'vapor@vapor.io'
Expand Down
3 changes: 1 addition & 2 deletions synse_server/routes/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
from sanic import Blueprint
from sanic.response import stream

from synse_server import commands, errors, validate
from synse_server import commands, errors, validate, __api_version__
from synse_server.i18n import _
from synse_server.log import logger
from synse_server.response import json
from synse_server.version import __api_version__

bp = Blueprint(__name__, url_prefix='/synse/' + __api_version__)

Expand Down
2 changes: 1 addition & 1 deletion synse_server/scheme/version.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Response scheme for the `version` endpoint."""

from synse_server.scheme.base_response import SynseResponse
from synse_server.version import __api_version__, __version__
from synse_server import __api_version__, __version__


class VersionResponse(SynseResponse):
Expand Down
16 changes: 0 additions & 16 deletions synse_server/version.py

This file was deleted.

8 changes: 4 additions & 4 deletions tests/end_to_end/test_synse.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
import requests
import ujson

import synse_server
from synse_server import errors
from synse_server.version import __api_version__, __version__

# get the host information via ENV, or use the default of localhost
host = os.environ.get('SYNSE_TEST_HOST', 'localhost')
Expand Down Expand Up @@ -115,7 +115,7 @@ def url_unversioned(uri):

def url(uri):
"""Create the versioned URL for Synse Server with the given URI."""
return 'http://{}:5000/synse/{}/{}'.format(host, __api_version__, uri)
return 'http://{}:5000/synse/{}/{}'.format(host, synse_server.__api_version__, uri)


def validate_write_ok(data, size):
Expand Down Expand Up @@ -351,8 +351,8 @@ def test_version_ok(self):
data = response.json()
assert 'version' in data
assert 'api_version' in data
assert data['version'] == __version__
assert data['api_version'] == __api_version__
assert data['version'] == synse_server.__version__
assert data['api_version'] == synse_server.__api_version__


#
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/aliases/test_boot_target_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.aliases' module's boot target route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_boot_target_route_url = '/synse/{}/boot_target/invalid-rack/invalid-board/invalid-device'\
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/aliases/test_fan_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.aliases' module's fan route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_fan_route_url = '/synse/{}/fan/invalid-rack/invalid-board/invalid-device'\
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/aliases/test_led_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.aliases' module's led route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_led_route_url = '/synse/{}/led/invalid-rack/invalid-board/invalid-device'\
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/aliases/test_lock_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.aliases' module's lock route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_lock_route_url = '/synse/{}/lock/invalid-rack/invalid-board/invalid-device'\
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/aliases/test_power_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.aliases' module's power route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_power_route_url = '/synse/{}/power/invalid-rack/invalid-board/invalid-device'\
Expand Down
6 changes: 3 additions & 3 deletions tests/integration/routes/base/test_version_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import ujson

from synse_server import version
import synse_server

version_url = '/synse/version'

Expand All @@ -16,8 +16,8 @@ def test_version_endpoint_ok(app):
assert 'version' in data
assert 'api_version' in data

assert data['version'] == version.__version__
assert data['api_version'] == version.__api_version__
assert data['version'] == synse_server.__version__
assert data['api_version'] == synse_server.__api_version__


def test_version_endpoint_post_not_allowed(app):
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_config_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import ujson

from synse_server.version import __api_version__
from synse_server import __api_version__

config_url = '/synse/{}/config'.format(__api_version__)

Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_info_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.core' module's info route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

info_url = '/synse/{}/info'.format(__api_version__)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_plugins_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import ujson

from synse_server.version import __api_version__
from synse_server import __api_version__

plugins_url = '/synse/{}/plugins'.format(__api_version__)

Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_read_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.core' module's read route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_read_url = '/synse/{}/read/invalid-rack/invalid-board/invalid-device'\
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_scan_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import ujson

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

scan_url = '/synse/{}/scan'.format(__api_version__)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_transaction_route.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Test the 'synse_server.routes.core' module's transaction route."""

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_transaction_url = '/synse/{}/transaction/invalid-id'.format(__api_version__)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/routes/core/test_write_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import ujson

from synse_server import errors
from synse_server.version import __api_version__
from synse_server import __api_version__
from tests import utils

invalid_write_url = '/synse/{}/write/invalid-rack/invalid-board/invalid-device'\
Expand Down
6 changes: 3 additions & 3 deletions tests/unit/routes/base/test_version_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import ujson
from sanic.response import HTTPResponse

from synse_server import version
import synse_server
from synse_server.routes.base import version_route
from tests import utils

Expand All @@ -22,5 +22,5 @@ async def test_synse_version_route():
assert 'version' in body
assert 'api_version' in body

assert body['version'] == version.__version__
assert body['api_version'] == version.__api_version__
assert body['version'] == synse_server.__version__
assert body['api_version'] == synse_server.__api_version__
6 changes: 3 additions & 3 deletions tests/unit/scheme/test_version_scheme.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Test the 'synse_server.scheme.version' Synse Server module."""

from synse_server import version
import synse_server
from synse_server.scheme.version import VersionResponse


Expand All @@ -10,6 +10,6 @@ def test_version_scheme():
response_scheme = VersionResponse()

assert response_scheme.data == {
'version': version.__version__,
'api_version': version.__api_version__
'version': synse_server.__version__,
'api_version': synse_server.__api_version__
}
15 changes: 0 additions & 15 deletions tests/unit/test_version.py

This file was deleted.