Thanks to visit codestin.com
Credit goes to github.com

Skip to content

update sheepdog for postgresql ssl support #349

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.

Sign up for GitHub

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

Closed
plooploops wants to merge 1 commit into from
Closed

update sheepdog for postgresql ssl support #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!.git/**
!.git
!.gitignore
!.github/**
5 changes: 5 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ COPY ./deployment/uwsgi/uwsgi.ini /etc/uwsgi/uwsgi.ini
WORKDIR /sheepdog
ENV CRYPTOGRAPHY_DONT_BUILD_RUST=1

# TODO: consider pinned version of pip.
# hadolint ignore=DL3013
RUN python -m pip install --upgrade pip \
&& python -m pip install --upgrade setuptools \
&& python /sheepdog/setup.py install \
&& pip --version \
&& pip install -r requirements.txt

Expand All @@ -24,6 +27,8 @@ RUN mkdir -p /var/www/sheepdog \

EXPOSE 80

# TODO: Check using legacy notation instead of backticked
# hadolint ignore=SC2006
RUN COMMIT=`git rev-parse HEAD` && echo "COMMIT=\"${COMMIT}\"" >sheepdog/version_data.py \
&& VERSION=`git describe --always --tags` && echo "VERSION=\"${VERSION}\"" >>sheepdog/version_data.py \
&& python setup.py install
Expand Down
151 changes: 123 additions & 28 deletions bin/setup_psqlgraph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,31 @@
from psqlgraph import create_all, Node, Edge


def try_drop_test_data(user, database, root_user="postgres", host="", root_password=""):
def try_drop_test_data( # nosec
user,
database="postgres",
root_user="postgres",
host="",
port="5432",
root_password="",
default_database="postgres",
use_ssl=False,
):
print("Dropping old test data")
connect_str = "postgres://{user}@{host}/postgres".format(user=root_user, host=host)
if root_password:
connect_str = "postgres://{user}:{password}@{host}/postgres".format(
user=root_user, password=root_password, host=host
)
connect_str = _get_connection_string(
user=root_user,
password=root_password,
host=host,
port=port,
database=default_database,
)

# added in for Postgresql SSL testing.
connect_args = {}
if use_ssl:
connect_args["sslmode"] = "require"

engine = create_engine(connect_str)
engine = create_engine(connect_str, connect_args=connect_args)

conn = engine.connect()
conn.execute("commit")
Expand All @@ -29,34 +45,69 @@ def try_drop_test_data(user, database, root_user="postgres", host="", root_passw
conn.close()


def setup_database(
def _get_connection_string(user, password, host, port, database):
connect_str = "postgres://{user}@{host}:{port}/{database}".format(
user=user, host=host, port=port, database=database
)
if password:
connect_str = "postgres://{user}:{password}@{host}:{port}/{database}".format(
user=user,
password=password,
host=host,
port=port,
database=database,
)
return connect_str


def setup_database( # nosec
user,
password,
database,
root_user="postgres",
host="",
port="5432",
no_drop=False,
no_user=False,
root_password="",
default_database="postgres",
use_ssl=False,
):
"""
setup the user and database
"""
print("Setting up test database")

if not no_drop:
try_drop_test_data(user, database, root_user, host, root_password)

connect_str = "postgres://{user}@{host}/postgres".format(user=root_user, host=host)
if password:
connect_str = "postgres://{user}:{password}@{host}/postgres".format(
user=root_user, password=root_password, host=host
try_drop_test_data(
user=user,
database=database,
root_user=root_user,
host=host,
port=port,
root_password=root_password,
default_database=default_database,
use_ssl=use_ssl,
)

engine = create_engine(connect_str)
connect_str = _get_connection_string(
user=root_user,
password=root_password,
host=host,
port=port,
database=default_database,
)

# added in for Postgresql SSL testing.
connect_args = {}
if use_ssl:
connect_args["sslmode"] = "require"

engine = create_engine(connect_str, connect_args=connect_args)
conn = engine.connect()
conn.execute("commit")

# Use default db connection to set up schema
create_stmt = 'CREATE DATABASE "{database}"'.format(database=database)
try:
conn.execute(create_stmt)
Expand All @@ -65,17 +116,18 @@ def setup_database(

if not no_user:
try:
user_no_host = user if "@" not in user else user.split("@")[0]
user_stmt = "CREATE USER {user} WITH PASSWORD '{password}'".format(
user=user, password=password
user=user_no_host, password=password
)
conn.execute(user_stmt)
except Exception as msg:
logging.warn("Unable to add user:" + str(msg))
# User may already exist - GRANT privs on new db
try:
perm_stmt = (
"GRANT ALL PRIVILEGES ON DATABASE {database} to {password}"
"".format(database=database, password=password)
"GRANT ALL PRIVILEGES ON DATABASE {database} to {user}"
"".format(database=database, user=user_no_host)
)
conn.execute(perm_stmt)
conn.execute("commit")
Expand All @@ -84,27 +136,40 @@ def setup_database(
conn.close()


def create_tables(host, user, password, database):
def create_tables(host, port, user, password, database, use_ssl=False):
"""
create a table
"""
print("Creating tables in test database")

# added for Postgresql SSL
connect_args = {}
if use_ssl:
connect_args["sslmode"] = "require"

engine = create_engine(
"postgres://{user}:{pwd}@{host}/{db}".format(
user=user, host=host, pwd=password, db=database
)
_get_connection_string(
user=user, password=password, host=host, port=port, database=database
),
connect_args=connect_args,
)
create_all(engine)
versioned_nodes.Base.metadata.create_all(engine)


def create_indexes(host, user, password, database):
def create_indexes(host, port, user, password, database, use_ssl=False):
print("Creating indexes")

# added for Postgresql SSL
connect_args = {}
if use_ssl:
connect_args["sslmode"] = "require"

engine = create_engine(
"postgres://{user}:{pwd}@{host}/{db}".format(
user=user, host=host, pwd=password, db=database
)
_get_connection_string(
user=user, password=password, host=host, port=port, database=database
),
connect_args=connect_args,
)
index = lambda t, c: ["CREATE INDEX ON {} ({})".format(t, x) for x in c]
for scls in Node.get_subclasses():
Expand Down Expand Up @@ -135,6 +200,9 @@ def create_indexes(host, user, password, database):
parser.add_argument(
"--host", type=str, action="store", default="localhost", help="psql-server host"
)
parser.add_argument(
"--port", type=str, action="store", default="5432", help="psql-server port"
)
parser.add_argument(
"--user", type=str, action="store", default="test", help="psql test user"
)
Expand All @@ -152,20 +220,47 @@ def create_indexes(host, user, password, database):
default="sheepdog_automated_test",
help="psql test database",
)
parser.add_argument(
"--default-database",
type=str,
action="store",
default="postgres",
help="psql test database for root user",
)
parser.add_argument(
"--no-drop", action="store_true", default=False, help="do not drop any data"
)
parser.add_argument(
"--no-user", action="store_true", default=False, help="do not create user"
)
parser.add_argument(
"--use-ssl", type=bool, action="store", default=False, help="Use Psql SSL"
)

args = parser.parse_args()
setup_database(
args.user,
args.password,
args.database,
port=args.port,
no_drop=args.no_drop,
no_user=args.no_user,
default_database=args.default_database,
use_ssl=args.use_ssl,
)
create_tables(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
create_indexes(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
create_tables(args.host, args.user, args.password, args.database)
create_indexes(args.host, args.user, args.password, args.database)
49 changes: 43 additions & 6 deletions bin/setup_test_database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
parser.add_argument(
"--host", type=str, action="store", default="localhost", help="psql-server host"
)
parser.add_argument(
"--port", type=str, action="store", default="5432", help="psql-server port"
)
parser.add_argument(
"--user", type=str, action="store", default="test", help="psql test user"
)
Expand All @@ -29,6 +32,13 @@
default="test",
help="psql test password",
)
parser.add_argument(
"--root_user",
type=str,
action="store",
default="postgres",
help="psql root (postgres) user name",
)
parser.add_argument(
"--root_password",
type=str,
Expand All @@ -49,17 +59,44 @@
parser.add_argument(
"--no-user", action="store_true", default=False, help="do not create user"
)
parser.add_argument(
"--use-ssl", type=bool, action="store", default=False, help="Use Psql SSL"
)

args = parser.parse_args()
setup_database(
args.user,
args.password,
args.database,
user=args.user,
password=args.password,
database=args.database,
root_user=args.root_user,
host=args.host,
port=args.port,
root_password=args.root_password,
no_drop=args.no_drop,
no_user=args.no_user,
use_ssl=args.use_ssl,
)
create_tables(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
create_indexes(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
create_transaction_logs_table(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
create_tables(args.host, args.user, args.password, args.database)
create_indexes(args.host, args.user, args.password, args.database)
create_transaction_logs_table(args.host, args.user, args.password, args.database)
28 changes: 23 additions & 5 deletions bin/setup_transactionlogs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@
from gdcdatamodel.models.submission import Base


def setup(host, user, password, database):
def setup(host, port, user, password, database, use_ssl=False):
connect_args = {}
if use_ssl:
connect_args["sslmode"] = "require"

engine = create_engine(
"postgres://{user}:{password}@{host}/{database}".format(
user=user, host=host, password=password, database=database
)
"postgres://{user}:{password}@{host}:{port}/{database}".format(
user=user, host=host, port=port, password=password, database=database
),
connect_args=connect_args,
)
Base.metadata.create_all(engine)

Expand All @@ -23,6 +28,9 @@ def setup(host, user, password, database):
parser.add_argument(
"--host", type=str, action="store", default="localhost", help="psql-server host"
)
parser.add_argument(
"--port", type=str, action="store", default="5432", help="psql-server port"
)
parser.add_argument(
"--user", type=str, action="store", default="test", help="psql test user"
)
Expand All @@ -40,6 +48,16 @@ def setup(host, user, password, database):
default="sheepdog_automated_test",
help="psql test database",
)
parser.add_argument(
"--use-ssl", type=bool, action="store", default=False, help="Use Psql SSL"
)

args = parser.parse_args()
setup(args.host, args.user, args.password, args.database)
setup(
args.host,
args.port,
args.user,
args.password,
args.database,
use_ssl=args.use_ssl,
)
1 change: 1 addition & 0 deletions deployment/scripts/postgresql/postgresql_test_init.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CREATE DATABASE sheepdog_automated_test;
Loading