#!/usr/bin/env python
# encoding: utf-8
"""
gaetk2.config - Configuration helpers for gaetk2/appengine.
Created by Maximillian Dornseif on 2018-02-17.
Copyright (c) HUDORA. MIT licensed.
"""
import os
import time
import warnings
from .runtime import get_config, set_config
from .internal import gaetkconfig
__all__ = [
'gaetkconfig',
'get_config',
'set_config',
'get_environment',
'get_release',
'get_revision',
'get_version',
'is_production',
]
[docs]def get_release():
"""Get the :term:`tagged version` of the current deployment.
Which usually means the first line :file:`gaetk2-release.txt`.
E.g. ``v180228-cg89bd1-production-dot-application.appspot.com``.
"""
try:
version = open('gaetk2-release.txt').readline().strip()
except IOError:
# if there is no version.txt file we return something fom the environment.
version = '{}-{}'.format(os.environ.get('CURRENT_VERSION_ID', 'dev'), time.time())
return version
[docs]def get_version():
"""Do not use this."""
warnings.warn("`get_version` is deprecated, use `get_release`", DeprecationWarning, stacklevel=2)
return get_release()
[docs]def get_revision():
"""Get the git SHA1 revision of the current deployment.
Get the first line of :file:`gaetk2-revision.txt`.
E.g. ``14006259d78fa918054f774d20480b52e38c4707``.
"""
try:
version = open('gaetk2-revision.txt').readline().strip()
except IOError:
version = 'HEAD'
return version
[docs]def get_environment():
"""Returns ``production``, ``staging``, ``testing`` or ``development`` depending on the Server Name.
See :term:`production version`, :term:`staging version`, :term:`testing version`,
and :term:`production version` for meaning."""
if os.environ.get('SERVER_NAME', '').startswith('production'):
return 'production'
elif os.environ.get('SERVER_NAME', '').startswith('staging'):
return 'staging'
elif (os.environ.get('SERVER_NAME', '').startswith('v') and
os.environ.get('SERVER_NAME', '').endswith('appspot.com')):
return 'testing'
elif os.environ.get('SERVER_NAME', '').startswith('test'):
return 'test'
return 'development'
[docs]def is_production():
"""checks if we can assume to run on a production version instance.
... unless called by the resttest-client.
See :term:`production version` what this means.
There are suble differences to
:func:`get_environment()` - read the code for details."""
if is_development():
return False
if os.environ.get('HTTP_USER_AGENT', '').startswith('resttest'):
return False
elif os.environ.get('SERVER_NAME', '').startswith('production'):
return True
elif os.environ.get('SERVER_NAME', '').startswith('staging'):
return True
elif (os.environ.get('SERVER_NAME', '').startswith('v') and
os.environ.get('SERVER_NAME', '').endswith('appspot.com')):
return False
else:
return True
def is_development():
"""Checks if we are running on a development system.
See :term:`development version` what this means."""
name = os.environ.get('SERVER_NAME', '')
return (os.environ.get('SERVER_SOFTWARE', '').startswith('Development') or
name.startswith('dev-') or name.startswith('test'))