Support Spigot

benwebber · benwebber · commit a53bb3f5bdc5 · 2016-07-31T19:01:14.000-04:00
* download and install Spigot BuildTools
  * build Spigot and symlink release
  * customize service templates for Minecraft/Spigot
  * add test suite for Spigot
  * add Spigot to Travis build matrix
diff --git a/.travis.yml b/.travis.yml
@@ -8,10 +8,14 @@ env:
     - DOCKER_VERSION=1.10.2-0~trusty
     - DOCKER_COMPOSE_VERSION=1.6.2
   matrix:
-    - OS=jessie64 PROCESS_CONTROL=systemd
-    - OS=jessie64 PROCESS_CONTROL=supervisor
-    - OS=trusty64 PROCESS_CONTROL=supervisor
-    - OS=centos7  PROCESS_CONTROL=systemd
+    - OS=jessie64 SERVER=minecraft PROCESS_CONTROL=systemd
+    - OS=jessie64 SERVER=minecraft PROCESS_CONTROL=supervisor
+    - OS=trusty64 SERVER=minecraft PROCESS_CONTROL=supervisor
+    - OS=centos7  SERVER=minecraft PROCESS_CONTROL=systemd
+    - OS=jessie64 SERVER=spigot    PROCESS_CONTROL=systemd
+    - OS=jessie64 SERVER=spigot    PROCESS_CONTROL=supervisor
+    - OS=trusty64 SERVER=spigot    PROCESS_CONTROL=supervisor
+    - OS=centos7  SERVER=spigot    PROCESS_CONTROL=systemd
 before_install:
   - sudo -E ./scripts/install-docker.sh
 install: true
diff --git a/Makefile b/Makefile
@@ -1,6 +1,7 @@
 BOXES := $(notdir $(wildcard docker/*))
 
 PROCESS_CONTROL ?= systemd
+SERVER          ?= minecraft
 
 define USAGE
 targets:
@@ -22,6 +23,7 @@ machines:
 variables:
 
   PROCESS_CONTROL   Choose from 'supervisor' or 'systemd'. Default: 'systemd'.
+  SERVER            Choose from 'minecraft' or 'spigot'. Default: 'minecraft'.
 endef
 
 is_machine_target = $(if $(findstring $(firstword $(MAKECMDGOALS)),$(BOXES)),true,false)
@@ -41,7 +43,7 @@ help:
 
 test:
 ifeq (true,$(call is_machine_target))
-	./scripts/ci.sh $(firstword $(MAKECMDGOALS)) $(PROCESS_CONTROL)
+	./scripts/ci.sh $(firstword $(MAKECMDGOALS)) $(PROCESS_CONTROL) $(SERVER)
 else
 	$(error `test` requires a machine name, see `make help`)
 endif
diff --git a/defaults/main.yml b/defaults/main.yml
@@ -17,3 +17,5 @@ minecraft_console_fifo: /run/{{ minecraft_service_name }}/console
 minecraft_console_fifo_mode: '0666'
 minecraft_process_control: systemd
 minecraft_server_properties: {}
+
+minecraft_spigot_url: https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
diff --git a/scripts/ci.sh b/scripts/ci.sh
@@ -4,6 +4,7 @@ IFS=$'\n\t'
 
 declare -r OS=${1:-${OS}}
 declare -r PROCESS_CONTROL=${2:-${PROCESS_CONTROL}}
+declare -r SERVER=${3:-${SERVER}}
 declare -r WORKSPACE=${WORKSPACE:-/tmp/ansible-minecraft}
 
 function cleanup() {
@@ -24,23 +25,23 @@ function main() {
               -i "${WORKSPACE}/tests/inventory" \
               --syntax-check \
               -v \
-              --extra-vars="minecraft_process_control=${PROCESS_CONTROL}" \
-              "${WORKSPACE}/tests/site.yml"
+              --extra-vars="minecraft_process_control=${PROCESS_CONTROL} minecraft_server=${SERVER}" \
+              "${WORKSPACE}/tests/${SERVER}.yml"
 
   # Install Minecraft.
   docker exec -t "${container}" ansible-playbook \
               -i "${WORKSPACE}/tests/inventory" \
               -c local \
               -v \
-              --extra-vars="minecraft_process_control=${PROCESS_CONTROL}" \
-              "${WORKSPACE}/tests/site.yml"
+              --extra-vars="minecraft_process_control=${PROCESS_CONTROL} minecraft_server=${SERVER}" \
+              "${WORKSPACE}/tests/${SERVER}.yml"
 
   # Sleep to allow Minecraft to boot.
   # FIXME: A retry loop checking if it has launched yet would be better.
   sleep 10
 
   # Run tests.
-  docker exec -t "${container}" rspec "${WORKSPACE}/tests/spec/minecraft_spec.rb"
+  docker exec -t "${container}" rspec "${WORKSPACE}/tests/spec/${SERVER}_spec.rb"
 }
 
 trap cleanup EXIT
diff --git a/tasks/configure.yml b/tasks/configure.yml
@@ -2,7 +2,7 @@
 # We send the stop command to the stdin to stop the server right after it
 # starts.
 - name: generate server.properties
-  shell: echo "/stop" | java -jar minecraft_server.jar nogui
+  shell: echo "/stop" | java -jar {{ minecraft_jar }} nogui
   args:
     creates: server.properties
     chdir: "{{ minecraft_home }}"
diff --git a/tasks/download/main.yml b/tasks/download/main.yml
@@ -1,2 +1,5 @@
 - include: minecraft.yml
   when: minecraft_server == 'minecraft'
+
+- include: spigot.yml
+  when: minecraft_server == 'spigot'
diff --git a/tasks/download/spigot.yml b/tasks/download/spigot.yml
@@ -0,0 +1,15 @@
+- name: create Spigot build directory
+  file:
+    path: "{{ minecraft_home }}/build"
+    state: directory
+    mode: 0755
+    owner: "{{ minecraft_user }}"
+    group: "{{ minecraft_group }}"
+
+- name: download Spigot build tools
+  get_url:
+    url: "{{ minecraft_spigot_url }}"
+    dest: "{{ minecraft_home }}/build"
+    owner: "{{ minecraft_user }}"
+    group: "{{ minecraft_group }}"
+    mode: 0755
diff --git a/tasks/install/main.yml b/tasks/install/main.yml
@@ -1,2 +1,5 @@
 - include: minecraft.yml
   when: minecraft_server == 'minecraft'
+
+- include: spigot.yml
+  when: minecraft_server == 'spigot'
diff --git a/tasks/install/spigot.yml b/tasks/install/spigot.yml
@@ -0,0 +1,30 @@
+- include: latest.yml
+  when: minecraft_version == 'latest'
+
+- name: build Spigot server
+  command: java -jar BuildTools.jar --rev "{{ minecraft_version_latest | default(minecraft_version) }}"
+  args:
+    creates: spigot-{{ minecraft_version_latest | default(minecraft_version) }}.jar
+    chdir: "{{ minecraft_home }}/build"
+  become: true
+  become_user: "{{ minecraft_user }}"
+
+- name: symlink Spigot server
+  file:
+    src: "{{ minecraft_home }}/build/spigot-{{ minecraft_version_latest | default(minecraft_version) }}.jar"
+    path: "{{ minecraft_home }}/spigot.jar"
+    owner: "{{ minecraft_user }}"
+    group: "{{ minecraft_group }}"
+    state: link
+  notify:
+    - restart Minecraft
+
+- name: agree to EULA
+  copy:
+    src: eula.txt
+    dest: "{{ minecraft_home }}/eula.txt"
+    mode: 0644
+    owner: "{{ minecraft_user }}"
+    group: "{{ minecraft_group }}"
+  notify:
+    - enable service
diff --git a/tasks/setup/Debian.yml b/tasks/setup/Debian.yml
@@ -4,3 +4,11 @@
     state=present
     install_recommends=no
   with_items: "{{ dependencies }}"
+
+- name: install Spigot dependencies
+  apt:
+    name: "{{ item }}"
+  with_items:
+    - git
+    - tar
+  when: minecraft_server == 'spigot'
diff --git a/tasks/setup/RedHat.yml b/tasks/setup/RedHat.yml
@@ -3,3 +3,11 @@
     name={{ item }}
     state=present
   with_items: "{{ dependencies }}"
+
+- name: install Spigot dependencies
+  yum:
+    name: "{{ item }}"
+  with_items:
+    - git
+    - tar
+  when: minecraft_server == 'spigot'
diff --git a/tasks/setup/main.yml b/tasks/setup/main.yml
@@ -22,6 +22,16 @@
     group={{ minecraft_group }}
     home={{ minecraft_home }}
 
+- name: set executable name (Minecraft)
+  set_fact:
+    minecraft_jar: minecraft_server.jar
+  when: minecraft_server == 'minecraft'
+
+- name: set executable name (Spigot)
+  set_fact:
+    minecraft_jar: spigot.jar
+  when: minecraft_server == 'spigot'
+
 - include: supervisor.yml
   when: minecraft_process_control == 'supervisor'
 
diff --git a/templates/minecraft.conf.j2 b/templates/minecraft.conf.j2
@@ -1,5 +1,5 @@
 [program:{{ minecraft_service_name }}]
-command=/usr/bin/java -Xmx{{ minecraft_max_memory}} -Xms{{ minecraft_initial_memory }} -jar minecraft_server.jar nogui
+command=/usr/bin/java -Xmx{{ minecraft_max_memory}} -Xms{{ minecraft_initial_memory }} -jar {{ minecraft_jar }} nogui
 directory={{ minecraft_home }}
 user={{ minecraft_user }}
 group={{ minecraft_group }}
diff --git a/templates/minecraft.service.j2 b/templates/minecraft.service.j2
@@ -12,7 +12,7 @@ WorkingDirectory={{ minecraft_home }}
 StandardInput=socket
 StandardOutput=journal
 StandardError=journal
-ExecStart=/usr/bin/java -Xmx{{ minecraft_max_memory }} -Xms{{ minecraft_initial_memory }} -jar minecraft_server.jar nogui
+ExecStart=/usr/bin/java -Xmx{{ minecraft_max_memory }} -Xms{{ minecraft_initial_memory }} -jar {{ minecraft_jar }} nogui
 ExecStop=/bin/sh -c "echo 'save-all' > {{ minecraft_console_fifo }}"
 ExecStop=/bin/sh -c "echo 'stop' > {{ minecraft_console_fifo }}"
 Restart=on-failure
diff --git a/tests/minecraft.yml b/tests/minecraft.yml
diff --git a/tests/spec/spigot_spec.rb b/tests/spec/spigot_spec.rb
@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+
+describe user 'spigot' do
+  it { should exist }
+end
+
+describe group 'spigot' do
+  it { should exist }
+end
+
+describe file '/srv/spigot' do
+  it {
+    should be_directory
+    should be_owned_by 'spigot'
+    should be_grouped_into 'spigot'
+  }
+end
+
+describe file '/srv/spigot/build/spigot-1.9.jar' do
+  it {
+    should be_file
+    should be_owned_by 'spigot'
+    should be_grouped_into 'spigot'
+  }
+end
+
+describe file '/srv/spigot/spigot.jar' do
+  it {
+    should be_symlink
+    should be_linked_to '/srv/spigot/build/spigot-1.9.jar'
+  }
+end
+
+describe file '/srv/spigot/eula.txt' do
+  its(:content) { should match 'true' }
+end
+
+java = case os[:family]
+       when 'redhat' then 'java-1.8.0-openjdk'
+       else 'default-jdk'
+       end
+
+describe package java do
+  it { should be_installed }
+end
+
+describe process 'java' do
+  its(:user) { should eq 'spigot' }
+  its(:args) { should match /java -Xmx1024M -Xms1024M -jar spigot\.jar nogui/ }
+end
+
+describe port 25565 do
+  it { should be_listening }
+end
+
+describe port 25564 do
+  it { should be_listening }
+end
+
+expected_hook_log = <<EOF
+before_setup
+after_setup
+before_download
+after_download
+before_install
+after_install
+before_start
+after_start
+EOF
+
+describe file '/tmp/hooks' do
+  its(:content) { should eq expected_hook_log }
+end
diff --git a/tests/spigot.yml b/tests/spigot.yml
@@ -0,0 +1,19 @@
+---
+- hosts: all
+  roles:
+   - role: benwebber.minecraft
+     minecraft_server: spigot
+     minecraft_version: 1.9
+     minecraft_server_properties:
+       server-port: 25565
+       rcon.port: 25564
+       enable-rcon: true
+       rcon.password: password
+     minecraft_hook_before_setup: "{{ playbook_dir }}/hooks/before_setup.yml"
+     minecraft_hook_after_setup: "{{ playbook_dir }}/hooks/after_setup.yml"
+     minecraft_hook_before_download: "{{ playbook_dir }}/hooks/before_download.yml"
+     minecraft_hook_after_download: "{{ playbook_dir }}/hooks/after_download.yml"
+     minecraft_hook_before_install: "{{ playbook_dir }}/hooks/before_install.yml"
+     minecraft_hook_after_install: "{{ playbook_dir }}/hooks/after_install.yml"
+     minecraft_hook_before_start: "{{ playbook_dir }}/hooks/before_start.yml"
+     minecraft_hook_after_start: "{{ playbook_dir }}/hooks/after_start.yml"
diff --git a/vars/main.yml b/vars/main.yml
@@ -4,3 +4,4 @@ supported_ansible_os_families:
   - RedHat
 supported_minecraft_servers:
   - minecraft
+  - spigot
