openstack/designate
Code Issues Proposed changes

Fix bashate errors

Browse Source 
This fixes the errors detected by bashate (kicked by `tox -e bashate`),
which has not been actually tested in CI.

Change-Id: I73f0748e05b8421ca988d3e888e54a7daa469ae8
This commit is contained in:
Takashi Kajinami 2024-01-27 19:17:22 +09:00
parent 73d83a9369
commit 781fb6dc4b
14 changed files with 48 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
devstack/designate_plugins/backend-akamai-v2
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the Akamai v2 backend
# Requirements:

1
devstack/designate_plugins/backend-bind9
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the bind9 pool backend
# Enable with:

4
devstack/designate_plugins/backend-designate
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the designate backend
# Requirements:
@ -65,7 +66,8 @@ function configure_designate_backend {
IFS=',' read -a nameservers <<< "$DESIGNATE_D2D_NAMESERVERS"
for nameserver in "${nameservers[@]}"; do
local nameserver_id=`uuidgen`
local nameserver_id
nameserver_id=`uuidgen`
iniset $DESIGNATE_CONF pool_nameserver:$nameserver_id host $(dig +short A $nameserver | head -n 1)
iniset $DESIGNATE_CONF pool_nameserver:$nameserver_id port 53

1
devstack/designate_plugins/backend-dynect
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the dynect backend
# Requirements:

1
devstack/designate_plugins/backend-fake
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the fake backend
# Enable with:

1
devstack/designate_plugins/backend-infoblox
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the infoblox backend
# Requirements:

1
devstack/designate_plugins/backend-ns1
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the NS1 backend
# Requirements:

1
devstack/designate_plugins/backend-pdns4
View File

@ -1,3 +1,4 @@
#!/usr/bin/env bash
# Configure the powerdns backend
# Enable with:

27
devstack/exercise.sh
View File

@ -22,7 +22,7 @@ SCRIPT_DIR=$(cd $(dirname "$0") && pwd)
DEVSTACK_DIR=$(cd $SCRIPT_DIR/../..; pwd)/devstack
if [ -x "$HOME/devstack/stack.sh" ]; then
DEVSTACK_DIR=$HOME/devstack/
DEVSTACK_DIR=$HOME/devstack/
fi
# Import common functions
@ -109,11 +109,13 @@ function ensure_record_absent {
# do an AXFR request to MDNS
# if it does not match the expected value, give an error
function verify_axfr_in_mdns {
local axfr_records
# Display for debugging
dig $DIG_AXFR_FLAGS "$1"
if dig $DIG_AXFR_FLAGS "$1"; then
if [ -n "$2" ] ; then
local axfr_records=$(dig $DIG_AXFR_FLAGS "$1" | grep "$1" | wc -l)
axfr_records=$(dig $DIG_AXFR_FLAGS "$1" | grep "$1" | wc -l)
if [ "$axfr_records" = "$2" ] ; then
return 0
else
@ -131,7 +133,8 @@ function verify_axfr_in_mdns {
function get_domain_id {
local domain_name=$1
local required=$2
local domain_id=$(designate domain-list | egrep " $domain_name " | get_field 1)
local domain_id
domain_id=$(designate domain-list | egrep " $domain_name " | get_field 1)
if [ "$required" = "1" ] ; then
die_if_not_set $LINENO domain_id "Failure retrieving DOMAIN_ID"
fi
@ -147,7 +150,8 @@ function get_domain_name {
# if the given domain does not exist, it will be created
# the domain_id of the domain will be returned
function get_or_create_domain_id {
local domainid=$(get_domain_id "$1")
local domainid
domainid=$(get_domain_id "$1")
if [[ -z "$domainid" ]]; then
designate domain-create --name $1 --email admin@devstack.org --ttl 86400 --description "domain $1" 1>&2
domainid=$(designate domain-list | grep "$1" | get_field 1)
@ -162,7 +166,8 @@ function get_record_id {
local record_name=$2
local record_type=$3
local required=$4
local record_id=$(designate record-list $domain_id | egrep " $record_name " | egrep " $record_type " | get_field 1)
local record_id
record_id=$(designate record-list $domain_id | egrep " $record_name " | egrep " $record_type " | get_field 1)
if [ "$required" = "1" ] ; then
die_if_not_set $LINENO record_id "Failure retrieving RECORD_ID"
fi
@ -179,7 +184,7 @@ designate server-list
NUMBER_OF_RECORDS=$(designate server-list -f csv | wc -l)
# Add 1 extra to account for the additional SOA at the end of the AXFR
((NUMBER_OF_RECORDS+=1))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
# Testing Domains
# ===============
@ -209,7 +214,7 @@ A_RECORD_NAME="$(openssl rand -hex 4).${DOMAIN_NAME}"
# Create an A record
designate record-create $DOMAIN_ID --name $A_RECORD_NAME --type A --data 127.0.0.1
((NUMBER_OF_RECORDS++))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
A_RECORD_ID=$(get_record_id $DOMAIN_ID $A_RECORD_NAME A)
# Fetch the record
@ -225,7 +230,7 @@ AAAA_RECORD_NAME="$(openssl rand -hex 4).${DOMAIN_NAME}"
# Create an AAAA record
designate record-create $DOMAIN_ID --name $AAAA_RECORD_NAME --type AAAA --data "2607:f0d0:1002:51::4"
((NUMBER_OF_RECORDS++))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
AAAA_RECORD_ID=$(get_record_id $DOMAIN_ID $AAAA_RECORD_NAME AAAA)
# Fetch the record
@ -238,7 +243,7 @@ ensure_record_present $AAAA_RECORD_NAME AAAA 2607:f0d0:1002:51::4
# Create a MX record
designate record-create $DOMAIN_ID --name $DOMAIN_NAME --type MX --priority 5 --data "mail.example.com."
((NUMBER_OF_RECORDS++))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
MX_RECORD_ID=$(get_record_id $DOMAIN_ID $DOMAIN_NAME MX)
# Fetch the record
@ -251,7 +256,7 @@ ensure_record_present $DOMAIN_NAME MX "5 mail.example.com."
# Create a SRV record
designate record-create $DOMAIN_ID --name _sip._tcp.$DOMAIN_NAME --type SRV --priority 10 --data "5 5060 sip.example.com."
((NUMBER_OF_RECORDS++))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
SRV_RECORD_ID=$(get_record_id $DOMAIN_ID _sip._tcp.$DOMAIN_NAME SRV)
# Fetch the record
@ -267,7 +272,7 @@ CNAME_RECORD_NAME="$(openssl rand -hex 4).${DOMAIN_NAME}"
# Create a CNAME record
designate record-create $DOMAIN_ID --name $CNAME_RECORD_NAME --type CNAME --data $DOMAIN_NAME
((NUMBER_OF_RECORDS++))
NUMBER_OF_RECORDS=$((NUMBER_OF_RECORDS+1))
CNAME_RECORD_ID=$(get_record_id $DOMAIN_ID $CNAME_RECORD_NAME CNAME)
# Fetch the record

2
devstack/lib/wsgi
View File

@ -1,3 +1,5 @@
#!/usr/bin/env bash
function designate_configure_uwsgi {
write_uwsgi_config "$DESIGNATE_UWSGI_CONF" "$DESIGNATE_UWSGI" "/dns"

17
devstack/plugin.sh
View File

@ -29,6 +29,9 @@ function cleanup_designate {
# configure_designate - Set config files, create data dirs, etc
function configure_designate {
local rootwrap_sudoer_cmd
local tempfile
[ ! -d $DESIGNATE_CONF_DIR ] && sudo mkdir -m 755 -p $DESIGNATE_CONF_DIR
sudo chown $STACK_USER $DESIGNATE_CONF_DIR
@ -96,8 +99,8 @@ function configure_designate {
iniset $DESIGNATE_CONF oslo_concurrency lock_path "$DESIGNATE_STATE_PATH"
# Set up the rootwrap sudoers for designate
local rootwrap_sudoer_cmd="$DESIGNATE_BIN_DIR/designate-rootwrap $DESIGNATE_ROOTWRAP_CONF *"
local tempfile=`mktemp`
rootwrap_sudoer_cmd="$DESIGNATE_BIN_DIR/designate-rootwrap $DESIGNATE_ROOTWRAP_CONF *"
tempfile=`mktemp`
echo "$STACK_USER ALL=(root) NOPASSWD: $rootwrap_sudoer_cmd" >$tempfile
chmod 0440 $tempfile
sudo chown root:root $tempfile
@ -136,7 +139,7 @@ function configure_designatedashboard {
}
# Configure the needed tempest options
function configure_designate_tempest() {
function configure_designate_tempest {
if is_service_enabled tempest; then
# Tell tempest we're available
iniset $TEMPEST_CONFIG service_available designate True
@ -179,10 +182,12 @@ function configure_designate_tempest() {
# ------------------------------------------------------------------
# service designate admin # if enabled
function create_designate_accounts {
local designate_api_url
if is_service_enabled designate-api; then
create_service_user "designate"
local designate_api_url="$DESIGNATE_SERVICE_PROTOCOL://$DESIGNATE_SERVICE_HOST/dns"
designate_api_url="$DESIGNATE_SERVICE_PROTOCOL://$DESIGNATE_SERVICE_HOST/dns"
get_or_create_service "designate" "dns" "Designate DNS Service"
get_or_create_endpoint \
@ -257,8 +262,8 @@ function install_designatedashboard {
setup_dev_lib "designate-dashboard"
for panel in _1710_project_dns_panel_group.py \
_1721_dns_zones_panel.py \
_1722_dns_reversedns_panel.py; do
_1721_dns_zones_panel.py \
_1722_dns_reversedns_panel.py; do
ln -fs $DESIGNATEDASHBOARD_DIR/designatedashboard/enabled/$panel $HORIZON_DIR/openstack_dashboard/local/enabled/$panel
done
}

2
devstack/upgrade/upgrade.sh
View File

@ -73,7 +73,7 @@ install_designateclient
# The designateclient may have changed location
# (/opt/stack/new/python-designateclient) so we need to restart neutron
if is_service_enabled q-svc; then
restart_service devstack@q-svc.service
restart_service devstack@q-svc.service
fi
# calls upgrade-designate for specific release

1
test-requirements.txt
View File

@ -17,3 +17,4 @@ pymemcache!=1.3.0,>=1.2.9 # Apache 2.0 License
PyMySQL>=0.8.0 # MIT License
edgegrid-python>=1.1.1 # Apache-2.0
infoblox-client>=0.6.0 # Apache-2.0
bashate>=0.5.1 # Apache-2.0

10
tox.ini
View File

@ -88,10 +88,12 @@ commands =
[testenv:pep8]
deps = -r{toxinidir}/test-requirements.txt
allowlist_externals = bash
commands =
flake8
{[testenv:bandit]commands}
doc8 {posargs}
{[testenv:bashate]commands}
[testenv:genconfig]
commands = oslo-config-generator --config-file=etc/designate/designate-config-generator.conf
@ -100,7 +102,7 @@ commands = oslo-config-generator --config-file=etc/designate/designate-config-ge
commands = oslopolicy-sample-generator --config-file etc/designate/designate-policy-generator.conf
[testenv:bashate]
deps = bashate
deps = -r{toxinidir}/test-requirements.txt
allowlist_externals = bash
commands = bash -c "find {toxinidir}/devstack \
-not \( -type d -name .?\* -prune \) \
@ -108,13 +110,15 @@ commands = bash -c "find {toxinidir}/devstack \
-type f \
-not -name \*~ \
-not -name \*.md \
-not -name \*.sql \
\( \
-name \*.sh -or \
-name \*rc -or \
-name functions\* -or \
-wholename \*/lib/\* \
-wholename \*/lib/\* -or \
-wholename \*/designate_plugins/\* \
\) \
-print0 | xargs -0 bashate -v"
-print0 | xargs -0 bashate -v -iE006 -eE005,E042"
[testenv:pip-check-reqs]
# do not install test-requirements as that will pollute the virtualenv for