Skip to content

In Au tests, poll for excretion of log file rather than waiting fixed delay. #6506

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

Merged
shinrich merged 1 commit into from
Mar 25, 2020
Merged

In Au tests, poll for excretion of log file rather than waiting fixed delay. #6506

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
9 changes: 5 additions & 4 deletions tests/gold_tests/h2/httpbin.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,10 @@
test_run.Processes.Default.Streams.stderr = "gold/httpbin_3_stderr.gold"
test_run.StillRunningAfter = httpbin


# Check Logging
# Wait for log file to appear, then wait one extra second to make sure TS is done writing it.
test_run = Test.AddTestRun()
test_run.DelayStart = 10
test_run.Processes.Default.Command = 'echo "Delay for log flush"'
test_run.Processes.Default.Command = (
os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' +
os.path.join(ts.Variables.LOGDIR, 'access.log')
)
Copy link
Member

@shinrich shinrich Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm understanding your condwait shell script correctly, it incorporates the sleeps. Why do you append an extra sleep at the invocation sites?

Copy link
Contributor Author

@ywkaras ywkaras Mar 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For an extra safety margin, to ensure that TS has time to finish writing the log file before its contents are checked.

Copy link
Member

@shinrich shinrich Mar 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't you include that in the script then?

Copy link
Contributor Author

@ywkaras ywkaras Mar 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK done.

test_run.Processes.Default.ReturnCode = 0
11 changes: 7 additions & 4 deletions tests/gold_tests/logging/custom-log.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,10 @@
ts.Variables.port)
tr.Processes.Default.ReturnCode = 0

tr = Test.AddTestRun()
tr.DelayStart = 10
tr.Processes.Default.Command = 'echo "Delay"'
tr.Processes.Default.ReturnCode = 0
# Wait for log file to appear, then wait one extra second to make sure TS is done writing it.
test_run = Test.AddTestRun()
test_run.Processes.Default.Command = (
os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' +
os.path.join(ts.Variables.LOGDIR, 'test_log_field.log')
)
test_run.Processes.Default.ReturnCode = 0
11 changes: 7 additions & 4 deletions tests/gold_tests/logging/log-field.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,10 @@
ts.Variables.port)
tr.Processes.Default.ReturnCode = 0

tr = Test.AddTestRun()
tr.DelayStart = 10
tr.Processes.Default.Command = 'echo "Delay for log flush"'
tr.Processes.Default.ReturnCode = 0
# Wait for log file to appear, then wait one extra second to make sure TS is done writing it.
test_run = Test.AddTestRun()
test_run.Processes.Default.Command = (
os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' +
os.path.join(ts.Variables.LOGDIR, 'field-test.log')
)
test_run.Processes.Default.ReturnCode = 0
11 changes: 7 additions & 4 deletions tests/gold_tests/logging/log-filter.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,10 @@
ts.Variables.port)
tr.Processes.Default.ReturnCode = 0

tr = Test.AddTestRun()
tr.DelayStart = 10
tr.Processes.Default.Command = 'echo "Delay for log flush"'
tr.Processes.Default.ReturnCode = 0
# Wait for log file to appear, then wait one extra second to make sure TS is done writing it.
test_run = Test.AddTestRun()
test_run.Processes.Default.Command = (
os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' +
os.path.join(ts.Variables.LOGDIR, 'filter-test.log')
)
test_run.Processes.Default.ReturnCode = 0
12 changes: 10 additions & 2 deletions tests/gold_tests/logging/new_log_flds.test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,18 @@
).format(ts.Variables.ssl_port)
tr.Processes.Default.ReturnCode = 0

# Delay to allow TS to flush report to disk, then validate generated log.
# Wait for log file to appear, then wait one extra second to make sure TS is done writing it.
#
test_run = Test.AddTestRun()
test_run.Processes.Default.Command = (
os.path.join(Test.Variables.AtsTestToolsDir, 'condwait') + ' 60 1 -f ' +
os.path.join(ts.Variables.LOGDIR, 'test_new_log_flds.log')
)
test_run.Processes.Default.ReturnCode = 0

# Validate generated log.
#
tr = Test.AddTestRun()
tr.DelayStart = 10
tr.Processes.Default.Command = 'python3 {0} < {1}'.format(
os.path.join(Test.TestDirectory, 'new_log_flds_observer.py'),
os.path.join(ts.Variables.LOGDIR, 'test_new_log_flds.log'))
Expand Down
74 changes: 74 additions & 0 deletions tests/tools/condwait
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
#!/bin/bash

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.

# A bash script to wait for a condition to be true.
#
# usage:
# condwait [ MAX-WAIT [ POST-WAIT ] ] CONDITION
#
# CONDITION is the ('test' command) condition to wait for. (It may contain white space.)
#
# MAX-WAIT is the maximum number of seconds to wait for the condition. If it is omitted, it defaults to 60.
#
# POST-WAIT is the number of seconds to wait after the condition is true. If it is omitted, it defaults to 0.
#
# The script exits with status 0 when the condition is seen to be true. It exits with status 1 if the condition
# is not seen to be true and the maximum wait has expired.

WAIT=60
POST_WAIT=0

if [[ "$1" = "" ]] ; then
echo "usage: condwait [ MAX-WAIT [ POST-WAIT ] ] TEST-CONDTION" >&2
exit 1
fi

X=$( echo "$1" | sed 's/x/yy/g' | sed 's/[^0-9]/x/g' )
if [[ "$X" = "$1" ]] ; then
WAIT=$1
shift
if [[ "$1" = "" ]] ; then
echo "usage: condwait [ MAX-WAIT [ POST-WAIT ] ] TEST-CONDTION" >&2
exit 1
fi
X=$( echo "$1" | sed 's/x/yy/g' | sed 's/[^0-9]/x/g' )
if [[ "$X" = "$1" ]] ; then
POST_WAIT=$1
shift
fi
fi

if [[ "$1" = "" ]] ; then
echo "usage: condwait [ MAX-WAIT [ POST-WAIT ] ] TEST-CONDTION" >&2
exit 1
fi

while (( WAIT > 0 ))
do
if test $*
then
if (( POST_WAIT > 0 ))
then
sleep $POST_WAIT
fi
exit 0
fi
sleep 1
let WAIT=WAIT-1
done
exit 1