forked from apache/trafficserver
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
escalate plugin: handle origin not reachable
Update the escalate plugin to handle dispatching to the failover server if the original server is down. This also adds a new autest for the escalate plugin. Fixes: apache#11836
- Loading branch information
Showing
4 changed files
with
627 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| ''' | ||
| ''' | ||
| # 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. | ||
|
|
||
| import os | ||
| from ports import get_port | ||
|
|
||
| Test.Summary = ''' | ||
| Test the escalate plugin. | ||
| ''' | ||
|
|
||
| Test.SkipUnless(Condition.PluginExists('escalate.so')) | ||
|
|
||
|
|
||
| class EscalateTest: | ||
| """ | ||
| Test the escalate plugin. | ||
| """ | ||
|
|
||
| _replay_original_file: str = 'escalate_original.replay.yaml' | ||
| _replay_failover_file: str = 'escalate_failover.replay.yaml' | ||
|
|
||
| def __init__(self): | ||
| '''Configure the test run.''' | ||
| tr = Test.AddTestRun('Test escalate plugin.') | ||
| self._setup_dns(tr) | ||
| self._setup_servers(tr) | ||
| self._setup_ts(tr) | ||
| self._setup_client(tr) | ||
|
|
||
| def _setup_dns(self, tr: 'Process') -> None: | ||
| '''Set up the DNS server. | ||
| :param tr: The test run to add the DNS server to. | ||
| ''' | ||
| self._dns = tr.MakeDNServer(f"dns", default='127.0.0.1') | ||
|
|
||
| def _setup_servers(self, tr: 'Process') -> None: | ||
| '''Set up the origin and failover servers. | ||
| :param tr: The test run to add the servers to. | ||
| ''' | ||
| tr.Setup.Copy(self._replay_original_file) | ||
| tr.Setup.Copy(self._replay_failover_file) | ||
| self._server_origin = tr.AddVerifierServerProcess(f"server_origin", self._replay_original_file) | ||
| self._server_failover = tr.AddVerifierServerProcess(f"server_failover", self._replay_failover_file) | ||
|
|
||
| self._server_origin.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: GET', "Verify the origin server received the GET request.") | ||
| self._server_origin.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: POST', "Verify the origin server received the POST request.") | ||
| self._server_origin.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: POST_failed', "Verify the origin server received the POST request that it returns a 502 with.") | ||
| self._server_origin.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: CHUNKED_POST', "Verify the origin server received the chunked POST request.") | ||
| self._server_origin.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: CHUNKED_POST_failed', "Verify the origin server received the chunked POST request that it returns a 502 with.") | ||
|
|
||
| self._server_failover.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: POST_failed', "Verify the failover server received the failed POST request.") | ||
| self._server_failover.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: CHUNKED_POST_failed', "Verify the failover server received the failed chunked POST request.") | ||
| self._server_failover.Streams.All += Testers.ContainsExpression( | ||
| 'uuid: POST_down_origin', "Verify the failover server received the POST request that the origin server is down.") | ||
|
|
||
| self._server_failover.Streams.All += Testers.ExcludesExpression( | ||
| 'uuid: GET', "Verify the failover server did not receive the GET request.") | ||
| self._server_failover.Streams.All += Testers.ExcludesExpression( | ||
| 'uuid: POST', "Verify the failover server did not receive the POST request.") | ||
| self._server_failover.Streams.All += Testers.ExcludesExpression( | ||
| 'uuid: CHUNKED_POST', "Verify the failover server did not receive the chunked POST request.") | ||
|
|
||
| def _setup_ts(self, tr: 'Process') -> None: | ||
| '''Set up Traffic Server. | ||
| :param tr: The test run to add Traffic Server to. | ||
| ''' | ||
| self._ts = tr.MakeATSProcess(f"ts", enable_cache=False) | ||
| # Select a port that is guaranteed to not be used at the moment. | ||
| dead_port = get_port(self._ts, "dead_port") | ||
| self._ts.Disk.records_config.update( | ||
| { | ||
| 'proxy.config.diags.debug.enabled': 1, | ||
| 'proxy.config.diags.debug.tags': 'http|escalate', | ||
| 'proxy.config.dns.nameservers': f'127.0.0.1:{self._dns.Variables.Port}', | ||
| 'proxy.config.dns.resolv_conf': 'NULL', | ||
| }) | ||
| self._ts.Disk.remap_config.AddLines( | ||
| [ | ||
| f'map https://origin.server.com https://backend.origin.server.com:{self._server_origin.Variables.http_port} ' | ||
| f'@plugin=escalate.so @pparam=500,502:failover.server.com:{self._server_failover.Variables.http_port} ' | ||
|
|
||
| # Now create remap entries for the multiplexed hosts: one that | ||
| # verifies HTTP, and another that verifies HTTPS. | ||
| f'map http://down_origin.server.com http://backend.down_origin.server.com:{dead_port} ' | ||
| f'@plugin=escalate.so @pparam=500,502:failover.server.com:{self._server_failover.Variables.http_port} ' | ||
| ]) | ||
|
|
||
| def _setup_client(self, tr: 'Process') -> None: | ||
| '''Set up the client. | ||
| :param tr: The test run to add the client to. | ||
| ''' | ||
| client = tr.AddVerifierClientProcess(f"client", self._replay_original_file, http_ports=[self._ts.Variables.port]) | ||
| client.StartBefore(self._dns) | ||
| client.StartBefore(self._server_origin) | ||
| client.StartBefore(self._server_failover) | ||
| client.StartBefore(self._ts) | ||
|
|
||
| client.Streams.All += Testers.ExcludesExpression(r'\[ERROR\]', 'Verify there were no errors in the replay.') | ||
| client.Streams.All += Testers.ExcludesExpression('400 Bad', 'Verify none of the 400 responses make it to the client.') | ||
| client.Streams.All += Testers.ExcludesExpression('502 Bad', 'Verify none of the 502 responses make it to the client.') | ||
| client.Streams.All += Testers.ExcludesExpression('500 Internal', 'Verify none of the 500 responses make it to the client.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: first', 'Verify that the first response was received.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: second', 'Verify that the second response was received.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: third', 'Verify that the third response was received.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: fourth', 'Verify that the fourth response was received.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: fifth', 'Verify that the fifth response was received.') | ||
| client.Streams.All += Testers.ContainsExpression('X-Response: sixth', 'Verify that the sixth response was received.') | ||
|
|
||
|
|
||
| EscalateTest() |
Oops, something went wrong.