From 3b4ca8e399ce99b065af20ee29ec339cee678eb9 Mon Sep 17 00:00:00 2001 From: Tanguy Leroux Date: Mon, 15 Jun 2015 16:31:43 +0200 Subject: [PATCH] Create PID_DIR in init.d script Since the /var/run/elasticsearch directory is cleaned when the operating system starts, the init.d script must ensure that the PID_DIR is correctly created. Closes #11594 --- core/src/packaging/deb/init.d/elasticsearch | 9 +- core/src/packaging/rpm/init.d/elasticsearch | 8 ++ .../{50_systemd.bats => 60_systemd.bats} | 24 ++++ .../packaging/scripts/70_sysv_initd.bats | 123 ++++++++++++++++++ 4 files changed, 163 insertions(+), 1 deletion(-) rename core/src/test/resources/packaging/scripts/{50_systemd.bats => 60_systemd.bats} (85%) create mode 100644 core/src/test/resources/packaging/scripts/70_sysv_initd.bats diff --git a/core/src/packaging/deb/init.d/elasticsearch b/core/src/packaging/deb/init.d/elasticsearch index ad192157231..2f05b0b8431 100755 --- a/core/src/packaging/deb/init.d/elasticsearch +++ b/core/src/packaging/deb/init.d/elasticsearch @@ -151,7 +151,14 @@ case "$1" in # Prepare environment mkdir -p "$LOG_DIR" "$DATA_DIR" && chown "$ES_USER":"$ES_GROUP" "$LOG_DIR" "$DATA_DIR" - touch "$PID_FILE" && chown "$ES_USER":"$ES_GROUP" "$PID_FILE" + + # Ensure that the PID_DIR exists (it is cleaned at OS startup time) + if [ -n "$PID_DIR" ] && [ ! -e "$PID_DIR" ]; then + mkdir -p "$PID_DIR" && chown "$ES_USER":"$ES_GROUP" "$PID_DIR" + fi + if [ -n "$PID_FILE" ] && [ ! -e "$PID_FILE" ]; then + touch "$PID_FILE" && chown "$ES_USER":"$ES_GROUP" "$PID_FILE" + fi if [ -n "$MAX_OPEN_FILES" ]; then ulimit -n $MAX_OPEN_FILES diff --git a/core/src/packaging/rpm/init.d/elasticsearch b/core/src/packaging/rpm/init.d/elasticsearch index 5fe9d748952..da3e5ac8b99 100644 --- a/core/src/packaging/rpm/init.d/elasticsearch +++ b/core/src/packaging/rpm/init.d/elasticsearch @@ -99,6 +99,14 @@ start() { fi export ES_GC_LOG_FILE + # Ensure that the PID_DIR exists (it is cleaned at OS startup time) + if [ -n "$PID_DIR" ] && [ ! -e "$PID_DIR" ]; then + mkdir -p "$PID_DIR" && chown "$ES_USER":"$ES_GROUP" "$PID_DIR" + fi + if [ -n "$pidfile" ] && [ ! -e "$pidfile" ]; then + touch "$pidfile" && chown "$ES_USER":"$ES_GROUP" "$pidfile" + fi + echo -n $"Starting $prog: " # if not running, start it up here, usually something like "daemon $exec" daemon --user $ES_USER --pidfile $pidfile $exec -p $pidfile -d -Des.default.path.home=$ES_HOME -Des.default.path.logs=$LOG_DIR -Des.default.path.data=$DATA_DIR -Des.default.path.conf=$CONF_DIR diff --git a/core/src/test/resources/packaging/scripts/50_systemd.bats b/core/src/test/resources/packaging/scripts/60_systemd.bats similarity index 85% rename from core/src/test/resources/packaging/scripts/50_systemd.bats rename to core/src/test/resources/packaging/scripts/60_systemd.bats index addd4ff1ac7..011b063a161 100644 --- a/core/src/test/resources/packaging/scripts/50_systemd.bats +++ b/core/src/test/resources/packaging/scripts/60_systemd.bats @@ -144,3 +144,27 @@ setup() { run systemctl status elasticsearch.service echo "$output" | grep "Active:" | grep "inactive" } + +# Simulates the behavior of a system restart: +# the PID directory is deleted by the operating system +# but it should not block ES from starting +# see https://github.com/elastic/elasticsearch/issues/11594 +@test "[SYSTEMD] delete PID_DIR and restart" { + skip_not_systemd + + run rm -rf /var/run/elasticsearch + [ "$status" -eq 0 ] + + run systemd-tmpfiles --create + [ "$status" -eq 0 ] + + run systemctl start elasticsearch.service + [ "$status" -eq 0 ] + + wait_for_elasticsearch_status + + assert_file_exist "/var/run/elasticsearch/elasticsearch.pid" + + run systemctl stop elasticsearch.service + [ "$status" -eq 0 ] +} \ No newline at end of file diff --git a/core/src/test/resources/packaging/scripts/70_sysv_initd.bats b/core/src/test/resources/packaging/scripts/70_sysv_initd.bats new file mode 100644 index 00000000000..0cd0d652c47 --- /dev/null +++ b/core/src/test/resources/packaging/scripts/70_sysv_initd.bats @@ -0,0 +1,123 @@ +#!/usr/bin/env bats + +# This file is used to test the elasticsearch init.d scripts. + +# WARNING: This testing file must be executed as root and can +# dramatically change your system. It removes the 'elasticsearch' +# user/group and also many directories. Do not execute this file +# unless you know exactly what you are doing. + +# The test case can be executed with the Bash Automated +# Testing System tool available at https://github.com/sstephenson/bats +# Thanks to Sam Stephenson! + +# Licensed to Elasticsearch under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch 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. + +# Load test utilities +load packaging_test_utils + +# Cleans everything for the 1st execution +setup() { + if [ "$BATS_TEST_NUMBER" -eq 1 ]; then + clean_before_test + fi + + # Installs a package before test + if is_dpkg; then + dpkg -i elasticsearch*.deb >&2 || true + fi + if is_rpm; then + rpm -i elasticsearch*.rpm >&2 || true + fi +} + +@test "[INIT.D] start" { + skip_not_sysvinit + + run service elasticsearch start + [ "$status" -eq 0 ] + + wait_for_elasticsearch_status + + assert_file_exist "/var/run/elasticsearch/elasticsearch.pid" +} + +@test "[INIT.D] status (running)" { + skip_not_sysvinit + + run service elasticsearch status + [ "$status" -eq 0 ] +} + +################################## +# Check that Elasticsearch is working +################################## +@test "[INIT.D] test elasticsearch" { + skip_not_sysvinit + + run_elasticsearch_tests +} + +@test "[INIT.D] restart" { + skip_not_sysvinit + + run service elasticsearch restart + [ "$status" -eq 0 ] + + wait_for_elasticsearch_status + + run service elasticsearch status + [ "$status" -eq 0 ] +} + +@test "[INIT.D] stop (running)" { + skip_not_sysvinit + + run service elasticsearch stop + [ "$status" -eq 0 ] + +} + +@test "[INIT.D] status (stopped)" { + skip_not_sysvinit + + run service elasticsearch status + [ "$status" -eq 3 ] +} + +# Simulates the behavior of a system restart: +# the PID directory is deleted by the operating system +# but it should not block ES from starting +# see https://github.com/elastic/elasticsearch/issues/11594 +@test "[INIT.D] delete PID_DIR and restart" { + skip_not_sysvinit + + run rm -rf /var/run/elasticsearch + [ "$status" -eq 0 ] + + + run service elasticsearch start + [ "$status" -eq 0 ] + + wait_for_elasticsearch_status + + assert_file_exist "/var/run/elasticsearch/elasticsearch.pid" + + run service elasticsearch stop + [ "$status" -eq 0 ] +} \ No newline at end of file