b8e3e9e1c2
A deployer may want to remove a Swift node from a load balancer for maintenance or upgrade. This patch provides an optional mechanism for this. The healthcheck filter config can specify "disable_path" which is a filesystem path. If a file is present at that location, the healthcheck middleware returns a 503 with a body of "DISABLED BY FILE". So a deployer can configure "disable_path" and then touch that filesystem path, wait for the proxy to be removed from the load balancer pool, perform maintenance/upgrade, and then remove the "disable_path" file. Also cleaned up the conf file man pages a bit. Change-Id: I1759c78c74910a54c720f298d4d8e6fa57a4dab4
81 lines
2.8 KiB
Python
81 lines
2.8 KiB
Python
# Copyright (c) 2010-2012 OpenStack, LLC.
|
|
#
|
|
# 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.
|
|
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
import unittest
|
|
|
|
from swift.common.swob import Request, Response
|
|
from swift.common.middleware import healthcheck
|
|
|
|
|
|
class FakeApp(object):
|
|
def __call__(self, env, start_response):
|
|
req = Request(env)
|
|
return Response(request=req, body='FAKE APP')(
|
|
env, start_response)
|
|
|
|
|
|
class TestHealthCheck(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.tempdir = tempfile.mkdtemp()
|
|
self.disable_path = os.path.join(self.tempdir, 'dont-taze-me-bro')
|
|
self.got_statuses = []
|
|
|
|
def tearDown(self):
|
|
shutil.rmtree(self.tempdir, ignore_errors=True)
|
|
|
|
def get_app(self, app, global_conf, **local_conf):
|
|
factory = healthcheck.filter_factory(global_conf, **local_conf)
|
|
return factory(app)
|
|
|
|
def start_response(self, status, headers):
|
|
self.got_statuses.append(status)
|
|
|
|
def test_healthcheck(self):
|
|
req = Request.blank('/healthcheck', environ={'REQUEST_METHOD': 'GET'})
|
|
app = self.get_app(FakeApp(), {})
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEquals(['200 OK'], self.got_statuses)
|
|
self.assertEquals(resp, ['OK'])
|
|
|
|
def test_healtcheck_pass(self):
|
|
req = Request.blank('/', environ={'REQUEST_METHOD': 'GET'})
|
|
app = self.get_app(FakeApp(), {})
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEquals(['200 OK'], self.got_statuses)
|
|
self.assertEquals(resp, ['FAKE APP'])
|
|
|
|
def test_healthcheck_pass_not_disabled(self):
|
|
req = Request.blank('/healthcheck', environ={'REQUEST_METHOD': 'GET'})
|
|
app = self.get_app(FakeApp(), {}, disable_path=self.disable_path)
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEquals(['200 OK'], self.got_statuses)
|
|
self.assertEquals(resp, ['OK'])
|
|
|
|
def test_healthcheck_pass_disabled(self):
|
|
open(self.disable_path, 'w')
|
|
req = Request.blank('/healthcheck', environ={'REQUEST_METHOD': 'GET'})
|
|
app = self.get_app(FakeApp(), {}, disable_path=self.disable_path)
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEquals(['503 Service Unavailable'], self.got_statuses)
|
|
self.assertEquals(resp, ['DISABLED BY FILE'])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|