starlingx/oidc-auth-armada-app
Code Issues Proposed changes

Enable helm plugin delivery with the application

Browse Source 
This creates a new package spec called python-k8sapp-oidc that will
build two packages: python-k8sapp-oidc and python-k8sapp-oidc-wheels.
These packages will hold all the stevedore plugins needed to support
the application.

These packages are included in the build dependencies for the
stx-oidc-auth-helm package build where the wheels file will
be included in the application tarball.

The helm plugins have been relocated to this repo and provided in
a k8sapp_oidc python module. This module will be extracted from the
wheels and installed on the platform via the sysinv application
framework. The module will be made available when the application
is enabled.

Now that the plugins and the application are residing in the same
repository, GITREVCOUNT will be used to drive the package version of
both to keep them in sync.

Tox test support has been provided for the plugin module.

Change-Id: Iead16c79aa1e3863d8568c9615f4215f2f6ec02b
Story: 2006537
Task: 39108
Depends-On: https://review.opendev.org/713969
Signed-off-by: Angie Wang <angie.wang@windriver.com>
Signed-off-by: Robert Church <robert.church@windriver.com>
This commit is contained in:
Angie Wang 2020-03-18 15:13:22 -04:00 committed by Robert Church
parent 775376f17e
commit f10e169367
31 changed files with 1228 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
.zuul.yaml
View File

@ -3,13 +3,95 @@
check:
jobs:
- openstack-tox-linters
- k8sapp-oidc-tox-py27
- k8sapp-oidc-tox-py36
- k8sapp-oidc-tox-flake8
- k8sapp-oidc-tox-pylint
- k8sapp-oidc-tox-bandit
gate:
jobs:
- openstack-tox-linters
- k8sapp-oidc-tox-py27
- k8sapp-oidc-tox-py36
- k8sapp-oidc-tox-flake8
- k8sapp-oidc-tox-pylint
- k8sapp-oidc-tox-bandit
post:
jobs:
- stx-oidc-auth-armada-app-upload-git-mirror
- job:
name: k8sapp-oidc-tox-py27
parent: tox
description: |
Run py27 test for k8sapp_oidc
nodeset: ubuntu-xenial
required-projects:
- starlingx/config
- starlingx/fault
- starlingx/update
- starlingx/utilities
files:
- python-k8sapp-oidc/*
vars:
tox_envlist: py27
tox_extra_args: -c python-k8sapp-oidc/k8sapp_oidc/tox.ini
- job:
name: k8sapp-oidc-tox-py36
parent: tox
description: |
Run py36 test for k8sapp_oidc
nodeset: ubuntu-bionic
required-projects:
- starlingx/config
- starlingx/fault
- starlingx/update
- starlingx/utilities
files:
- python-k8sapp-oidc/*
vars:
tox_envlist: py36
tox_extra_args: -c python-k8sapp-oidc/k8sapp_oidc/tox.ini
- job:
name: k8sapp-oidc-tox-flake8
parent: tox
description: |
Run flake8 test for k8sapp_oidc
files:
- python-k8sapp-oidc/*
vars:
tox_envlist: flake8
tox_extra_args: -c python-k8sapp-oidc/k8sapp_oidc/tox.ini
- job:
name: k8sapp-oidc-tox-pylint
parent: tox
description: |
Run pylint test for k8sapp_oidc
required-projects:
- starlingx/config
- starlingx/fault
- starlingx/update
- starlingx/utilities
files:
- python-k8sapp-oidc/*
vars:
tox_envlist: pylint
tox_extra_args: -c python-k8sapp-oidc/k8sapp_oidc/tox.ini
- job:
name: k8sapp-oidc-tox-bandit
parent: tox
description: |
Run bandit test for k8sapp_oidc
files:
- python-k8sapp-oidc/*
vars:
tox_envlist: bandit
tox_extra_args: -c python-k8sapp-oidc/k8sapp_oidc/tox.ini
- job:
name: stx-oidc-auth-armada-app-upload-git-mirror
parent: upload-git-mirror

1
centos_build_layer.cfg Normal file
View File

@ -0,0 +1 @@
flock

1
centos_pkg_dirs
View File

@ -1,3 +1,4 @@
dex-helm
stx-oidc-auth-helm
oidc-auth-tools
python-k8sapp-oidc

2
centos_pkg_dirs_containers Normal file
View File

@ -0,0 +1,2 @@
stx-oidc-auth-helm
python-k8sapp-oidc

6
python-k8sapp-oidc/centos/build_srpm.data Normal file
View File

@ -0,0 +1,6 @@
SRC_DIR="k8sapp_oidc"
# Keep the SRCREV in sync with stx-oidc-auth-helm so the app version is the same
# as the plugin version
TIS_BASE_SRCREV=860834c14ba54eb047ef02bde7a1f2407ce700ad
TIS_PATCH_VER=GITREVCOUNT

61
python-k8sapp-oidc/centos/python-k8sapp-oidc.spec Normal file
View File

@ -0,0 +1,61 @@
%global app_name oidc-auth-apps
%global pypi_name k8sapp-oidc
%global sname k8sapp_oidc
Name: python-%{pypi_name}
Version: 1.0
Release: %{tis_patch_ver}%{?_tis_dist}
Summary: StarlingX sysinv extensions: OIDC authorization K8S app
License: Apache-2.0
Source0: %{name}-%{version}.tar.gz
BuildArch: noarch
BuildRequires: python-setuptools
BuildRequires: python-pbr
BuildRequires: python2-pip
BuildRequires: python2-wheel
%description
StarlingX sysinv extensions: OIDC authorization K8S app
%package -n python2-%{pypi_name}
Summary: StarlingX sysinv extensions: OIDC authorization K8S app
Requires: python-pbr >= 2.0.0
Requires: sysinv >= 1.0
%description -n python2-%{pypi_name}
StarlingX sysinv extensions: OIDC authorization K8S app
%prep
%setup
# Remove bundled egg-info
rm -rf %{pypi_name}.egg-info
%build
export PBR_VERSION=%{version}
%{__python2} setup.py build
%py2_build_wheel
%install
export PBR_VERSION=%{version}.%{tis_patch_ver}
export SKIP_PIP_INSTALL=1
%{__python2} setup.py install --skip-build --root %{buildroot}
mkdir -p ${RPM_BUILD_ROOT}/plugins/%{app_name}
install -m 644 dist/*.whl ${RPM_BUILD_ROOT}/plugins/%{app_name}/
%files
%{python2_sitelib}/%{sname}
%{python2_sitelib}/%{sname}-*.egg-info
%package wheels
Summary: %{name} wheels
%description wheels
Contains python wheels for %{name}
%files wheels
/plugins/*

35
python-k8sapp-oidc/k8sapp_oidc/.gitignore vendored Normal file
View File

@ -0,0 +1,35 @@
# Compiled files
*.py[co]
*.a
*.o
*.so
# Sphinx
_build
doc/source/api/
# Packages/installer info
*.egg
*.egg-info
dist
build
eggs
parts
var
sdist
develop-eggs
.installed.cfg
# Other
*.DS_Store
.stestr
.testrepository
.tox
.venv
.*.swp
.coverage
bandit.xml
cover
AUTHORS
ChangeLog
*.sqlite

4
python-k8sapp-oidc/k8sapp_oidc/.stestr.conf Normal file
View File

@ -0,0 +1,4 @@
[DEFAULT]
test_path=./k8sapp_oidc/tests
top_dir=./k8sapp_oidc
#parallel_class=True

202
python-k8sapp-oidc/k8sapp_oidc/LICENSE Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019 Wind River Systems, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

7
python-k8sapp-oidc/k8sapp_oidc/README.rst Normal file
View File

@ -0,0 +1,7 @@
k8sapp-oidc
===========
This project contains StarlingX Kubernetes application specific python plugins
for the oidc authorization application. These plugins are required to integrate the
oidc authorization application into the StarlingX application framework and to support
the various StarlingX deployments.

0
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/__init__.py Normal file
View File

0
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/common/__init__.py Normal file
View File

10
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/common/constants.py Normal file
View File

@ -0,0 +1,10 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
# Helm: Supported charts:
# These values match the names in the chart package's Chart.yaml
HELM_CHART_DEX = 'dex'
HELM_CHART_OIDC_CLIENT = 'oidc-client'

0
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/helm/__init__.py Normal file
View File

69
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/helm/dex.py Normal file
View File

@ -0,0 +1,69 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from k8sapp_oidc.common import constants as app_constants
from k8sapp_oidc.helm.dex_base import DexBaseHelm
from sysinv.common import exception
from sysinv.helm import common
class Dex(DexBaseHelm):
"""Class to encapsulate helm operations for the dex chart"""
CHART = app_constants.HELM_CHART_DEX
SERVICE_NAME = 'dex'
def get_namespaces(self):
return self.SUPPORTED_NAMESPACES
def _get_static_clients(self):
static_clients = []
oidc_client = {
'id': self._get_client_id(),
'redirectURIs': ["https://%s:%s/callback" %
(self._format_url_address(self._get_oam_address()),
self.OIDC_CLIENT_NODE_PORT)],
'name': 'STX OIDC Client app',
'secret': self._get_client_secret()
}
static_clients.append(oidc_client)
return static_clients
def get_overrides(self, namespace=None):
ports = []
dex_port = {
'name': 'http',
'containerPort': 5556,
'protocol': 'TCP',
'nodePort': self.DEX_NODE_PORT,
}
ports.append(dex_port)
overrides = {
common.HELM_NS_KUBE_SYSTEM: {
'config': {
'issuer': "https://%s:%s/dex" % (self._format_url_address(self._get_oam_address()),
self.DEX_NODE_PORT),
'staticClients': self._get_static_clients(),
},
'ports': ports,
'replicas': self._num_provisioned_controllers(),
}
}
if namespace in self.SUPPORTED_NAMESPACES:
return overrides[namespace]
elif namespace:
raise exception.InvalidHelmNamespace(chart=self.CHART,
namespace=namespace)
else:
return overrides

40
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/helm/dex_base.py Normal file
View File

@ -0,0 +1,40 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from sysinv.common import constants
from sysinv.helm import base
from sysinv.helm import common
class DexBaseHelm(base.BaseHelm):
"""Class to encapsulate helm operations for the dex chart"""
SUPPORTED_NAMESPACES = base.BaseHelm.SUPPORTED_NAMESPACES + \
[common.HELM_NS_KUBE_SYSTEM]
SUPPORTED_APP_NAMESPACES = {
constants.HELM_APP_OIDC_AUTH:
base.BaseHelm.SUPPORTED_NAMESPACES + [common.HELM_NS_KUBE_SYSTEM],
}
# OIDC client and DEX Node ports
OIDC_CLIENT_NODE_PORT = 30555
DEX_NODE_PORT = 30556
@property
def CHART(self):
# subclasses must define the property: CHART='name of chart'
# if an author of a new chart forgets this, NotImplementedError is raised
raise NotImplementedError
def get_namespaces(self):
return self.SUPPORTED_NAMESPACES
def _get_client_id(self):
return 'stx-oidc-client-app'
def _get_client_secret(self):
return 'St8rlingX'

49
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/helm/oidc_client.py Normal file
View File

@ -0,0 +1,49 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from k8sapp_oidc.common import constants as app_constants
from k8sapp_oidc.helm.dex_base import DexBaseHelm
from sysinv.common import exception
from sysinv.helm import common
class OidcClientHelm(DexBaseHelm):
"""Class to encapsulate helm operations for the OIDC client chart"""
CHART = app_constants.HELM_CHART_OIDC_CLIENT
SERVICE_NAME = 'oidc_client'
def get_namespaces(self):
return self.SUPPORTED_NAMESPACES
def get_overrides(self, namespace=None):
oam_url = self._format_url_address(self._get_oam_address())
overrides = {
common.HELM_NS_KUBE_SYSTEM: {
'config': {
'client_id': self._get_client_id(),
'client_secret': self._get_client_secret(),
'issuer': "https://%s:%s/dex" % (oam_url, self.DEX_NODE_PORT),
'issuer_root_ca': '/home/dex-ca.pem',
'listen': 'https://0.0.0.0:5555',
'redirect_uri': "https://%s:%s/callback" % (oam_url, self.OIDC_CLIENT_NODE_PORT),
},
'service': {
'nodePort': self.OIDC_CLIENT_NODE_PORT
},
'replicas': self._num_provisioned_controllers(),
}
}
if namespace in self.SUPPORTED_NAMESPACES:
return overrides[namespace]
elif namespace:
raise exception.InvalidHelmNamespace(chart=self.CHART,
namespace=namespace)
else:
return overrides

0
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/tests/__init__.py Normal file
View File

69
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/tests/test_dex.py Normal file
View File

@ -0,0 +1,69 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from k8sapp_oidc.common import constants as app_constants
from k8sapp_oidc.tests import test_plugins
from sysinv.common import constants
from sysinv.common import utils
from sysinv.db import api as dbapi
from sysinv.helm import common
from sysinv.tests.db import base as dbbase
from sysinv.tests.db import utils as dbutils
from sysinv.tests.helm import base
class DexTestCase(test_plugins.K8SAppOidcAppMixin,
base.HelmTestCaseMixin):
def setUp(self):
super(DexTestCase, self).setUp()
self.app = dbutils.create_test_app(name='oidc-auth-apps')
self.dbapi = dbapi.get_instance()
def test_issuer(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_DEX,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
oam_addr_name = utils.format_address_name(constants.CONTROLLER_HOSTNAME,
constants.NETWORK_TYPE_OAM)
oam_address = self.dbapi.address_get_by_name(oam_addr_name)
config_issuer = "https://%s:30556/dex" % (utils.format_url_address(oam_address.address))
self.assertOverridesParameters(overrides, {
# issuer is set properly
'config': {'issuer': config_issuer}
})
class DexIPv4ControllerHostTestCase(DexTestCase,
dbbase.ProvisionedControllerHostTestCase):
def test_replicas(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_DEX,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
self.assertOverridesParameters(overrides, {
# 1 replica for 1 controller
'replicas': 1
})
class DexIPv6AIODuplexSystemTestCase(DexTestCase,
dbbase.BaseIPv6Mixin,
dbbase.ProvisionedAIODuplexSystemTestCase):
def test_replicas(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_DEX,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
self.assertOverridesParameters(overrides, {
# 2 replicas for 2 controllers
'replicas': 2
})

73
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/tests/test_oidc_client.py Normal file
View File

@ -0,0 +1,73 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from k8sapp_oidc.common import constants as app_constants
from k8sapp_oidc.tests import test_plugins
from sysinv.common import constants
from sysinv.common import utils
from sysinv.db import api as dbapi
from sysinv.helm import common
from sysinv.tests.db import base as dbbase
from sysinv.tests.db import utils as dbutils
from sysinv.tests.helm import base
class OidcClientTestCase(test_plugins.K8SAppOidcAppMixin,
base.HelmTestCaseMixin):
def setUp(self):
super(OidcClientTestCase, self).setUp()
self.app = dbutils.create_test_app(name=self.app_name)
self.dbapi = dbapi.get_instance()
def test_addresses(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_OIDC_CLIENT,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
oam_addr_name = utils.format_address_name(constants.CONTROLLER_HOSTNAME,
constants.NETWORK_TYPE_OAM)
address = self.dbapi.address_get_by_name(oam_addr_name)
oam_url = utils.format_url_address(address.address)
parameters = {
'config': {
'issuer': 'https://%s:30556/dex' % oam_url,
'redirect_uri': "https://%s:30555/callback" % oam_url,
}
}
self.assertOverridesParameters(overrides, parameters)
class OidcClientIPv4ControllerHostTestCase(OidcClientTestCase,
dbbase.ProvisionedControllerHostTestCase):
def test_replicas(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_DEX,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
self.assertOverridesParameters(overrides, {
# Only one replica for a single controller
'replicas': 1
})
class OidcClientIPv6ControllerHostTestCase(OidcClientTestCase,
dbbase.BaseIPv6Mixin,
dbbase.ProvisionedControllerHostTestCase):
pass
class OidcClientIPv4AIODuplexSystemTestCase(OidcClientTestCase,
dbbase.ProvisionedAIODuplexSystemTestCase):
def test_replicas(self):
overrides = self.operator.get_helm_chart_overrides(
app_constants.HELM_CHART_DEX,
cnamespace=common.HELM_NS_KUBE_SYSTEM)
self.assertOverridesParameters(overrides, {
# Expect two replicas because there are two controllers
'replicas': 2
})

42
python-k8sapp-oidc/k8sapp_oidc/k8sapp_oidc/tests/test_plugins.py Normal file
View File

@ -0,0 +1,42 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
from sysinv.common import constants
from sysinv.tests.db import base as dbbase
from sysinv.tests.helm.test_helm import HelmOperatorTestSuiteMixin
class K8SAppOidcAppMixin(object):
app_name = constants.HELM_APP_OIDC_AUTH
path_name = app_name + '.tgz'
def setUp(self):
super(K8SAppOidcAppMixin, self).setUp()
# Test Configuration:
# - Controller
# - IPv6
# - Ceph Storage
# - oidc-auth-apps app
class K8SAppOidcControllerTestCase(K8SAppOidcAppMixin,
dbbase.BaseIPv6Mixin,
dbbase.BaseCephStorageBackendMixin,
HelmOperatorTestSuiteMixin,
dbbase.ControllerHostTestCase):
pass
# Test Configuration:
# - AIO
# - IPv4
# - Ceph Storage
# - oidc-auth-apps app
class K8SAppOidcAIOTestCase(K8SAppOidcAppMixin,
dbbase.BaseCephStorageBackendMixin,
HelmOperatorTestSuiteMixin,
dbbase.AIOSimplexHostTestCase):
pass

238
python-k8sapp-oidc/k8sapp_oidc/pylint.rc Normal file
View File

@ -0,0 +1,238 @@
[MASTER]
# Specify a configuration file.
rcfile=pylint.rc
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Add files or directories to the blacklist. Should be base names, not paths.
ignore=tests
# Pickle collected data for later comparisons.
persistent=yes
# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
load-plugins=
# Use multiple processes to speed up Pylint.
jobs=4
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code
extension-pkg-whitelist=lxml.etree,greenlet
[MESSAGES CONTROL]
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time.
#enable=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once).
# See "Messages Control" section of
# https://pylint.readthedocs.io/en/latest/user_guide
# We are disabling (C)onvention
# We are disabling (R)efactor
disable=C, R
[REPORTS]
# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html
output-format=text
# Put messages in a separate file for each module / package specified on the
# command line instead of printing them on stdout. Reports (if any) will be
# written in a file name "pylint_global.[txt|html]".
files-output=no
# Tells whether to display a full report or only the messages
reports=yes
# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
[SIMILARITIES]
# Minimum lines number of a similarity.
min-similarity-lines=4
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
[FORMAT]
# Maximum number of characters on a single line.
max-line-length=85
# Maximum number of lines in a module
max-module-lines=1000
# String used as indentation unit. This is usually 4 spaces or "\t" (1 tab).
indent-string=' '
[TYPECHECK]
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis
ignored-modules=distutils,eventlet.green.subprocess,six,six.moves
# List of classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set).
# pylint is confused by sqlalchemy Table, as well as sqlalchemy Enum types
# ie: (unprovisioned, identity)
# LookupDict in requests library confuses pylint
ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local,
Table, unprovisioned, identity, LookupDict
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E0201 when accessed. Python regular
# expressions are accepted.
generated-members=REQUEST,acl_users,aq_parent
[BASIC]
# List of builtins function names that should not be used, separated by a comma
bad-functions=map,filter,apply,input
# Regular expression which should only match correct module names
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
# Regular expression which should only match correct module level names
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
# Regular expression which should only match correct class names
class-rgx=[A-Z_][a-zA-Z0-9]+$
# Regular expression which should only match correct function names
function-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct method names
method-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct instance attribute names
attr-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct argument names
argument-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct variable names
variable-rgx=[a-z_][a-z0-9_]{2,30}$
# Regular expression which should only match correct list comprehension /
# generator expression variable names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_
# Bad variable names which should always be refused, separated by a comma
bad-names=foo,bar,baz,toto,tutu,tata
# Regular expression which should only match functions or classes name which do
# not require a docstring
no-docstring-rgx=__.*__
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX,TODO
[VARIABLES]
# Tells whether we should check for unused import in __init__ files.
init-import=no
# A regular expression matching the beginning of the name of dummy variables
# (i.e. not used).
dummy-variables-rgx=_|dummy
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=
[IMPORTS]
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled)
import-graph=
# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled)
ext-import-graph=
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled)
int-import-graph=
[DESIGN]
# Maximum number of arguments for function / method
max-args=5
# Argument names that match this expression will be ignored. Default to name
# with leading underscore
ignored-argument-names=_.*
# Maximum number of locals for function / method body
max-locals=15
# Maximum number of return / yield for function / method body
max-returns=6
# Maximum number of branch for function / method body
max-branchs=12
# Maximum number of statements in function / method body
max-statements=50
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
[CLASSES]
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,__new__,setUp
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception

2
python-k8sapp-oidc/k8sapp_oidc/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
pbr>=2.0.0
PyYAML==3.10

40
python-k8sapp-oidc/k8sapp_oidc/setup.cfg Normal file
View File

@ -0,0 +1,40 @@
[metadata]
name = k8sapp-oidc
summary = StarlingX sysinv extensions for oidc-auth-apps
long_description = file: README.rst
long_description_content_type = text/x-rst
license = Apache 2.0
author = StarlingX
author-email = starlingx-discuss@lists.starlingx.io
home-page = https://www.starlingx.io/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.4
Programming Language :: Python :: 3.5
[files]
packages =
k8sapp_oidc
[global]
setup-hooks =
pbr.hooks.setup_hook
[entry_points]
systemconfig.helm_applications =
oidc-auth-apps = systemconfig.helm_plugins.oidc_auth_apps
systemconfig.helm_plugins.oidc_auth_apps =
001_dex = k8sapp_oidc.helm.dex:Dex
002_oidc-client = k8sapp_oidc.helm.oidc_client:OidcClientHelm
[wheel]
universal = 1

12
python-k8sapp-oidc/k8sapp_oidc/setup.py Normal file
View File

@ -0,0 +1,12 @@
#
# Copyright (c) 2020 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
import setuptools
setuptools.setup(
setup_requires=['pbr>=2.0.0'],
pbr=True)

26
python-k8sapp-oidc/k8sapp_oidc/test-requirements.txt Normal file
View File

@ -0,0 +1,26 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
flake8<3.8.0
pycodestyle<2.6.0 # MIT License
hacking>=1.1.0,<=2.0.0 # Apache-2.0
coverage>=3.6
discover
fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0.0 # BSD
passlib>=1.7.0
psycopg2-binary
python-subunit>=0.0.18
requests-mock>=0.6.0 # Apache-2.0
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
oslosphinx<2.6.0,>=2.5.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
stestr>=1.0.0 # Apache-2.0
testrepository>=0.0.18
testtools!=1.2.0,>=0.9.36
tempest-lib<0.5.0,>=0.4.0
ipaddr
pytest
pyudev
migrate
markupsafe

131
python-k8sapp-oidc/k8sapp_oidc/tox.ini Normal file
View File

@ -0,0 +1,131 @@
[tox]
envlist = flake8,py27,py36,pylint,bandit
minversion = 1.6
# skipsdist = True
#,pip-missing-reqs
# tox does not work if the path to the workdir is too long, so move it to /tmp
toxworkdir = /tmp/{env:USER}_k8soidctox
stxdir = {toxinidir}/../../..
distshare={toxworkdir}/.tox/distshare
[testenv]
# usedevelop = True
# enabling usedevelop results in py27 develop-inst:
# Exception: Versioning for this project requires either an sdist tarball,
# or access to an upstream git repository.
# Note. site-packages is true and rpm-python must be yum installed on your dev machine.
sitepackages = True
# tox is silly... these need to be separated by a newline....
whitelist_externals = bash
find
install_command = pip install \
-v -v -v \
-c{toxinidir}/upper-constraints.txt \
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/stable/stein/upper-constraints.txt} \
{opts} {packages}
# Note the hash seed is set to 0 until can be tested with a
# random hash seed successfully.
setenv = VIRTUAL_ENV={envdir}
PYTHONHASHSEED=0
PYTHONDONTWRITEBYTECODE=1
OS_TEST_PATH=./k8sapp_oidc/tests
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
EVENTS_YAML=./k8sapp_oidc/tests/events_for_testing.yaml
SYSINV_TEST_ENV=True
TOX_WORK_DIR={toxworkdir}
PYLINTHOME={toxworkdir}
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
-e{[tox]stxdir}/config/sysinv/sysinv/sysinv
-e{[tox]stxdir}/config/tsconfig/tsconfig
-e{[tox]stxdir}/fault/fm-api
-e{[tox]stxdir}/fault/python-fmclient/fmclient
-e{[tox]stxdir}/utilities/ceph/python-cephclient/python-cephclient
-e{[tox]stxdir}/update/cgcs-patch/cgcs-patch
commands =
find . -type f -name "*.pyc" -delete
[flake8]
exclude = build,dist,tools,.eggs
max-line-length=120
[testenv:flake8]
basepython = python3
deps = -r{toxinidir}/test-requirements.txt
flake8-bugbear
commands =
flake8 {posargs} .
[testenv:py27]
basepython = python2.7
commands =
{[testenv]commands}
stestr run {posargs}
stestr slowest
[testenv:py36]
basepython = python3.6
commands =
{[testenv]commands}
stestr run {posargs}
stestr slowest
[testenv:pep8]
# testenv:flake8 clone
basepython = {[testenv:flake8]basepython}
deps = {[testenv:flake8]deps}
commands = {[testenv:flake8]commands}
[testenv:venv]
commands = {posargs}
[bandit]
[testenv:bandit]
basepython = python3
deps = -r{toxinidir}/test-requirements.txt
bandit
commands = bandit --ini tox.ini -n 5 -r k8sapp_oidc
[testenv:pylint]
basepython = python2.7
sitepackages = False
deps = {[testenv]deps}
pylint
commands =
pylint {posargs} k8sapp_oidc --rcfile=./pylint.rc
[testenv:cover]
basepython = python2.7
deps = {[testenv]deps}
setenv = {[testenv]setenv}
PYTHON=coverage run --parallel-mode
commands =
{[testenv]commands}
coverage erase
stestr run {posargs}
coverage combine
coverage html -d cover
coverage xml -o cover/coverage.xml
coverage report
[testenv:pip-missing-reqs]
# do not install test-requirements as that will pollute the virtualenv for
# determining missing packages
# this also means that pip-missing-reqs must be installed separately, outside
# of the requirements.txt files
deps = pip_missing_reqs
-rrequirements.txt
commands=pip-missing-reqs -d --ignore-file=/k8sapp_oidc/tests k8sapp_oidc

1
python-k8sapp-oidc/k8sapp_oidc/upper-constraints.txt Normal file
View File

@ -0,0 +1 @@
# Override upstream constraints based on StarlingX load

5
stx-oidc-auth-helm/centos/build_srpm.data
View File

@ -1,3 +1,6 @@
SRC_DIR="stx-oidc-auth-helm"
TIS_PATCH_VER=0
# Keep the SRCREV in sync with python-k8sapp-oidc so the app version is the same
# as the plugin version
TIS_BASE_SRCREV=860834c14ba54eb047ef02bde7a1f2407ce700ad
TIS_PATCH_VER=GITREVCOUNT

10
stx-oidc-auth-helm/centos/stx-oidc-auth-helm.spec
View File

@ -8,7 +8,7 @@
# Build variables
%global helm_folder /usr/lib/helm
Summary: StarlingX OIDC auth Helm charts
Summary: StarlingX K8S application: OIDC authorization
Name: stx-oidc-auth-helm
Version: 1.0
Release: %{tis_patch_ver}%{?_tis_dist}
@ -23,10 +23,12 @@ BuildArch: noarch
BuildRequires: helm
BuildRequires: dex-helm
BuildRequires: python-k8sapp-oidc
BuildRequires: python-k8sapp-oidc-wheels
Requires: dex-helm
%description
StarlingX OIDC auth Helm charts
The StarlingX K8S application for OIDC authorization
%prep
%setup
@ -82,6 +84,10 @@ sed -i 's/@APP_NAME@/%{app_name}/g' %{app_staging}/metadata.yaml
sed -i 's/@APP_VERSION@/%{version}-%{tis_patch_ver}/g' %{app_staging}/metadata.yaml
sed -i 's/@HELM_REPO@/%{helm_repo}/g' %{app_staging}/metadata.yaml
# Copy the plugins: installed in the buildroot
mkdir -p %{app_staging}/plugins
cp /plugins/%{app_name}/*.whl %{app_staging}/plugins
# package it up
find . -type f ! -name '*.md5' -print0 | xargs -0 md5sum > checksum.md5
tar -zcf %{_builddir}/%{app_tarball} -C %{app_staging}/ .

13
tox.ini
View File

@ -33,3 +33,16 @@ commands =
[testenv:linters]
commands =
{[testenv:bashate]commands}
[testenv:flake8]
basepython = python3
description = Dummy environment to allow flake8 to be run in subdir tox
[testenv:pylint]
basepython = python3
description = Dummy environment to allow pylint to be run in subdir tox
[testenv:bandit]
basepython = python3
description = Dummy environment to allow bandit to be run in subdir tox