--- /dev/null
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package org.sonar.process;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang.StringUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+public class MinimumViableEnvironment {
+
+ private final Map<String, String> requiredJavaOptions = new HashMap<String, String>();
+
+ public MinimumViableEnvironment setRequiredJavaOption(String propertyKey, String expectedValue) {
+ requiredJavaOptions.put(propertyKey, expectedValue);
+ return this;
+ }
+
+ /**
+ * Entry point for all checks
+ */
+ public void check() {
+ checkJavaVersion();
+ checkJavaOptions();
+ checkWritableTempDir();
+ }
+
+ /**
+ * Verify that temp directory is writable
+ */
+ private void checkWritableTempDir() {
+ String tempPath = System.getProperty("java.io.tmpdir");
+ try {
+ File tempFile = File.createTempFile("check", "tmp", new File(tempPath));
+ FileUtils.deleteQuietly(tempFile);
+ } catch (IOException e) {
+ throw new MessageException(String.format(
+ "Temp directory is not writable: %s. Reason: %s", tempPath, e.getMessage()));
+ }
+ }
+
+ void checkJavaOptions() {
+ for (Map.Entry<String, String> entry : requiredJavaOptions.entrySet()) {
+ String value = System.getProperty(entry.getKey());
+ if (!StringUtils.equals(value, entry.getValue())) {
+ throw new MessageException(String.format(
+ "JVM option '%s' must be set to '%s'. Got '%s'", entry.getKey(), entry.getValue(), StringUtils.defaultString(value)));
+ }
+ }
+ }
+
+ void checkJavaVersion() {
+ String javaVersion = System.getProperty("java.version");
+ checkJavaVersion(javaVersion);
+ }
+
+ void checkJavaVersion(String javaVersion) {
+ if (javaVersion.startsWith("1.3") || javaVersion.startsWith("1.4") || javaVersion.startsWith("1.5")) {
+ // still better than "java.lang.UnsupportedClassVersionError: Unsupported major.minor version 49.0
+ throw new MessageException(String.format("Minimal required Java version is 1.6. Got %s.", javaVersion));
+ }
+ }
+
+ static class MessageException extends RuntimeException {
+ private MessageException(String message) {
+ super(message);
+ }
+
+ /**
+ * Does not fill in the stack trace
+ *
+ * @see java.lang.Throwable#fillInStackTrace()
+ */
+ @Override
+ public synchronized Throwable fillInStackTrace() {
+ return this;
+ }
+ }
+}
--- /dev/null
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package org.sonar.process;
+
+import org.fest.assertions.Assertions;
+import org.junit.Test;
+
+import static org.fest.assertions.Fail.fail;
+
+public class MinimumViableEnvironmentTest {
+
+ /**
+ * Verifies that all checks can be verified without error.
+ * Test environment does not necessarily follows all checks.
+ */
+ @Test
+ public void check() throws Exception {
+ MinimumViableEnvironment mve = new MinimumViableEnvironment();
+
+ try {
+ mve.check();
+ // ok
+ } catch (MinimumViableEnvironment.MessageException e) {
+ // also ok. All other exceptions are errors.
+ }
+ }
+
+ @Test
+ public void checkJavaVersion() throws Exception {
+ MinimumViableEnvironment mve = new MinimumViableEnvironment();
+
+ // yes, sources are compiled with a supported Java version!
+ mve.checkJavaVersion();
+
+ mve.checkJavaVersion("1.6.1_b2");
+ try {
+ mve.checkJavaVersion("1.5.2");
+ fail();
+ } catch (MinimumViableEnvironment.MessageException e) {
+ Assertions.assertThat(e).hasMessage("Minimal required Java version is 1.6. Got 1.5.2.");
+ }
+ }
+
+ @Test
+ public void checkJavaOption() throws Exception {
+ String key = "MinimumViableEnvironmentTest.test.prop";
+ MinimumViableEnvironment mve = new MinimumViableEnvironment()
+ .setRequiredJavaOption(key, "true");
+
+ try {
+ System.setProperty(key, "false");
+ mve.checkJavaOptions();
+ fail();
+ } catch (MinimumViableEnvironment.MessageException e) {
+ Assertions.assertThat(e).hasMessage("JVM option '" + key + "' must be set to 'true'. Got 'false'");
+ }
+
+ System.setProperty(key, "true");
+ mve.checkJavaOptions();
+ // do not fail
+ }
+}
#--------------------------------------------------------------------------------------------------
# NOTIFICATIONS
-# Delay (in seconds) between processing of notification queue
-sonar.notifications.delay=60
+# Delay in seconds between processing of notification queue. Default is 60.
+#sonar.notifications.delay=60
+
#--------------------------------------------------------------------------------------------------
# PROFILING
import org.elasticsearch.node.NodeBuilder;
import org.slf4j.LoggerFactory;
import org.sonar.process.ConfigurationUtils;
+import org.sonar.process.MinimumViableEnvironment;
import org.sonar.process.MonitoredProcess;
import org.sonar.process.Props;
import org.sonar.search.script.ListUpdate;
SearchServer(Props props) throws Exception {
super(props);
+ new MinimumViableEnvironment().check();
}
@Override
+++ /dev/null
-# Properties are set by Maven. See profile start-dev-server.
import org.slf4j.LoggerFactory;
import org.sonar.process.ConfigurationUtils;
+import org.sonar.process.MinimumViableEnvironment;
import org.sonar.process.MonitoredProcess;
import org.sonar.process.Props;
WebServer(Props props) throws Exception {
super(props);
+ new MinimumViableEnvironment()
+ .setRequiredJavaOption("file.encoding", "UTF-8")
+ .check();
this.tomcat = new EmbeddedTomcat(props);
}
return tomcat.isReady();
}
+ /**
+ * Can't be started as is. Needs to be bootstrapped by sonar-application
+ */
public static void main(String[] args) throws Exception {
Props props = ConfigurationUtils.loadPropsFromCommandLineArgs(args);
Logging.init(props);
-# This file must contain only ISO 8859-1 characters
-# see http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)
+# This file must contain only ISO 8859-1 characters.
+# See http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html#load(java.io.InputStream)
#
-# To use an environment variable, use the following syntax : ${env:NAME_OF_ENV_VARIABLE}
-# For example:
-# sonar.jdbc.url= ${env:SONAR_JDBC_URL}
-
-
-#--------------------------------------------------------------------------------------------------
-# TO BE DOCUMENTED - WORK IN PROGRESS
-#sonar.search.javaOpts=-Djava.net.preferIPv4Stack=true -Djava.awt.headless=true -Xmx256m -Xms256m -Xss256k -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseCMSInitiatingOccupancyOnly
-#sonar.search.port=9001
-#sonar.search.jmxPort=9002
-
-# For debug only
-#sonar.search.httpPort=
-
-#sonar.web.javaOpts=-server -Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError
-#sonar.web.jmxPort=9003
-
-# Paths are absolute or relative to installation root directory
-#sonar.path.data=data
-#sonar.path.logs=logs
-#sonar.path.temp=temp
+# Property values can:
+# - reference an environment variable, for example sonar.jdbc.url= ${env:SONAR_JDBC_URL}
+# - be encrypted. See http://docs.codehaus.org/display/SONAR/Settings+Encryption
#--------------------------------------------------------------------------------------------------
# DATABASE
#
-# IMPORTANT: the embedded H2 database is used by default. It is recommended for tests only.
-# Please use a production-ready database. Supported databases are MySQL, Oracle, PostgreSQL
-# and Microsoft SQLServer.
+# IMPORTANT: the embedded H2 database is used by default. It is recommended for tests but not for
+# production use. Supported databases are MySQL, Oracle, PostgreSQL and Microsoft SQLServer.
# User credentials.
# Permissions to create tables, indices and triggers must be granted to JDBC user.
#sonar.jdbc.username=sonar
#sonar.jdbc.password=sonar
-#----- Embedded database H2
-# Note: it does not accept connections from remote hosts, so the
-# SonarQube server and the maven plugin must be executed on the same host.
-
-# Comment the following line to deactivate the default embedded database.
+#----- Embedded database
+# It does not accept connections from remote hosts, so the
+# SonarQube server and the analyzers must be executed on the same host.
sonar.jdbc.url=jdbc:h2:tcp://localhost:9092/sonar
# directory containing H2 database files. By default it's the /data directory in the SonarQube installation.
#----- Oracle 10g/11g
-# To connect to Oracle database:
-#
-# - It's recommended to use the latest version of the JDBC driver (ojdbc6.jar).
-# Download it in http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html
-# - Copy the driver to the directory extensions/jdbc-driver/oracle/
+# - Only versions 11.2.* of Oracle JDBC driver are supported, even if connecting to lower Oracle versions.
+# - The JDBC driver must be copied into the directory extensions/jdbc-driver/oracle/
# - If you need to set the schema, please refer to http://jira.codehaus.org/browse/SONAR-5000
# - Comment the embedded database and uncomment the following line:
#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE
#----- PostgreSQL 8.x/9.x
-# Comment the embedded database and uncomment the following property to use PostgreSQL.
+# Comment the embedded database and uncomment the following property to connect to PostgreSQL.
# If you don't use the schema named "public", please refer to http://jira.codehaus.org/browse/SONAR-5000
#sonar.jdbc.url=jdbc:postgresql://localhost/sonar
-#----- Microsoft SQLServer
-# The Jtds open source driver is available in extensions/jdbc-driver/mssql. More details on http://jtds.sourceforge.net
+#----- Microsoft SQLServer 2005/2008
+# Only the distributed jTDS driver is supported and must not be changed.
#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor
#--------------------------------------------------------------------------------------------------
# WEB SERVER
+# Web server is executed in a dedicated Java process. By default its heap size is 768Mb.
+# Use the following property to customize JVM options. Enabling the HotSpot Server VM
+# mode (-server) is recommended.
+# Note that the option -Dfile.encoding=UTF-8 is mandatory.
+#sonar.web.javaOpts=-Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError \
+# -Djava.awt.headless=true -Dfile.encoding=UTF-8 -Djruby.management.enabled=false
+
+# Web server requires a JMX RMI port to be open. Default is 9003. A free port is
+# dynamically used is value is 0.
+# This JMX port must be private and must not be exposed to the Internet.
+#sonar.web.jmxPort=9003
+
# Binding IP address. For servers with more than one IP address, this property specifies which
# address will be used for listening on the specified ports.
# By default, ports will be used on all IP addresses associated with the server.
# Access logs are enabled by default.
#sonar.web.accessLogs.enable=true
-# TCP port for incoming AJP connections. Disabled when value is -1.
-# sonar.ajp.port=9009
+# TCP port for incoming AJP connections. Disabled if value is -1. Disabled by default.
+#sonar.ajp.port=-1
+
+
+#--------------------------------------------------------------------------------------------------
+# SEARCH INDEX
+
+# Elasticsearch is used to facilitate fast and accurate information retrieval.
+# It is executed in a dedicated Java process.
+
+# JVM options. Note that enabling the HotSpot Server VM mode (-server) is recommended.
+#sonar.search.javaOpts=-Xmx256m -Xms256m -Xss256k -Djava.net.preferIPv4Stack=true \
+# -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 \
+# -XX:+UseCMSInitiatingOccupancyOnly -XX:+HeapDumpOnOutOfMemoryError \
+# -Djava.awt.headless=true
+
+# Elasticsearch port. Default is 9001. Use 0 to get a free port.
+# This port must be private and must not be exposed to the Internet.
+#sonar.search.port=9001
+# JMX RMI port to monitor Elasticsearch process. Default is 9002. Use 0 to get a free port.
+# It must be private and must not be exposed to the Internet.
+#sonar.search.jmxPort=9002
#--------------------------------------------------------------------------------------------------
# UPDATE CENTER
-# The Update Center requires an internet connection to request http://update.sonarsource.org
+# Update Center requires an internet connection to request http://update.sonarsource.org
# It is enabled by default.
#sonar.updatecenter.activate=true
#--------------------------------------------------------------------------------------------------
-# NOTIFICATIONS
-
-# Delay (in seconds) between processing of notification queue
-sonar.notifications.delay=60
+# LOGGING
-#--------------------------------------------------------------------------------------------------
-# PROFILING
-# Level of information displayed in the logs: NONE (default), BASIC (functional information) and FULL (functional and technical details)
+# Level of information displayed in the logs: NONE (default), BASIC (functional information)
+# and FULL (functional and technical details)
#sonar.log.profilingLevel=NONE
+# Path to log files. Can be absolute or relative to installation directory.
+# Default is <installation home>/logs
+#sonar.path.logs=logs
+
#--------------------------------------------------------------------------------------------------
-# DEVELOPMENT MODE
-# Only for debugging
+# OTHERS
+
+# Delay in seconds between processing of notification queue. Default is 60 seconds.
+#sonar.notifications.delay=60
-# Set to true to apply Ruby on Rails code changes on the fly
-#sonar.rails.dev=false
+# Paths to persistent data files (embedded database and search index) and temporary files.
+# Can be absolute or relative to installation directory.
+# Defaults are respectively <installation home>/data and <installation home>/temp
+#sonar.path.data=data
+#sonar.path.temp=temp
# Application parameters. Add parameters as needed starting from 1
wrapper.app.parameter.1=org.sonar.application.App
-# Do not touch the following property. Max memory is set with -Xmx (see above).
-# See https://jira.codehaus.org/browse/SONAR-5204
wrapper.java.maxmemory=0
#********************************************************************
wrapper.console.format=PM
# Log Level for console output. (See docs for log levels)
-wrapper.console.loglevel=ERROR
+wrapper.console.loglevel=INFO
# Log file to use for wrapper output logging.
wrapper.logfile=../../logs/application.log
wrapper.logfile.format=M
# Log Level for log file output. (See docs for log levels)
-wrapper.logfile.loglevel=ERROR
+wrapper.logfile.loglevel=INFO
# Maximum size that the log file will be allowed to grow to before
# the log is rolled. Size is specified in bytes. The default value
# Forking Properties
#********************************************************************
wrapper.disable_restarts=TRUE
-wrapper.shutdown.timeout=30
-wrapper.jvm_exit.timeout=30
wrapper.ping.timeout=0
.setWorkDir(installation.homeDir())
.setJmxPort(Integer.parseInt(installation.prop(DefaultSettings.WEB_JMX_PORT_KEY)))
.addJavaOpts(installation.prop(DefaultSettings.WEB_JAVA_OPTS_KEY))
- .addJavaOpts(DefaultSettings.WEB_JAVA_OPTS_APPENDED_VAL)
.addJavaOpts(String.format("-Djava.io.tmpdir=%s", installation.tempDir().getAbsolutePath()))
.addJavaOpts(String.format("-Dsonar.path.logs=%s", installation.logsDir().getAbsolutePath()))
.setClassName("org.sonar.server.app.WebServer")
private static final int WEB_JMX_PORT_DEFVAL = 9003;
static final String WEB_JAVA_OPTS_KEY = "sonar.web.javaOpts";
- private static final String WEB_JAVA_OPTS_DEFVAL = "-server -Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError";
- static final String WEB_JAVA_OPTS_APPENDED_VAL = "-Djava.awt.headless=true -Dfile.encoding=UTF-8 -Djruby.management.enabled=false";
+ private static final String WEB_JAVA_OPTS_DEFVAL = "-Xmx768m -XX:MaxPermSize=160m -XX:+HeapDumpOnOutOfMemoryError -Djava.awt.headless=true -Dfile.encoding=UTF-8 -Djruby.management.enabled=false";
static final String JDBC_LOGIN_KEY = "sonar.jdbc.username";
private static final String JDBC_LOGIN_DEFVAL = "sonar";
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOUtils;
+import org.sonar.process.MinimumViableEnvironment;
import org.sonar.process.Props;
import javax.annotation.CheckForNull;
systemProperties.putAll(System.getenv());
systemProperties.putAll(System.getProperties());
- init(new SystemChecks(), detectHomeDir(), systemProperties);
+ init(new MinimumViableEnvironment(), detectHomeDir(), systemProperties);
}
- Installation(SystemChecks systemChecks, File homeDir, Properties systemProperties) throws URISyntaxException, IOException {
- init(systemChecks, homeDir, systemProperties);
+ Installation(MinimumViableEnvironment minimumViableEnvironment, File homeDir, Properties systemProperties) throws URISyntaxException, IOException {
+ init(minimumViableEnvironment, homeDir, systemProperties);
}
- void init(SystemChecks systemChecks, File homeDir, Properties systemProperties) throws URISyntaxException, IOException {
- systemChecks.checkJavaVersion();
+ void init(MinimumViableEnvironment minViableEnv, File homeDir, Properties systemProperties) throws URISyntaxException, IOException {
+ minViableEnv.check();
this.homeDir = homeDir;
props = initProps(homeDir, systemProperties);
File dir = configuredDir(propKey, defaultRelativePath);
FileUtils.deleteQuietly(dir);
FileUtils.forceMkdir(dir);
-
- // verify that temp directory is writable
- File tempFile = File.createTempFile("check", "tmp", dir);
- FileUtils.deleteQuietly(tempFile);
-
return dir;
}
+++ /dev/null
-/*
- * SonarQube, open source software quality management tool.
- * Copyright (C) 2008-2014 SonarSource
- * mailto:contact AT sonarsource DOT com
- *
- * SonarQube is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * SonarQube is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package org.sonar.application;
-
-class SystemChecks {
-
- void checkJavaVersion() {
- String javaVersion = System.getProperty("java.version");
- checkJavaVersion(javaVersion);
- }
-
- void checkJavaVersion(String javaVersion) {
- if (javaVersion.startsWith("1.3") || javaVersion.startsWith("1.4") || javaVersion.startsWith("1.5")) {
- // still better than "java.lang.UnsupportedClassVersionError: Unsupported major.minor version 49.0
- throw new IllegalStateException("Minimal required Java version if 1.6. Got: " + javaVersion);
- }
- }
-}
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
+import org.sonar.process.MinimumViableEnvironment;
import java.io.File;
import java.io.IOException;
Properties initialProps = new Properties();
initialProps.setProperty("foo", "bar");
- Installation installation = new Installation(new SystemChecks(), homeDir, initialProps);
+ Installation installation = new Installation(new MinimumViableEnvironment(), homeDir, initialProps);
assertThat(installation.logsDir()).isEqualTo(logsDir);
assertThat(installation.homeDir()).isEqualTo(homeDir);
File dataDir = new File(homeDir, "data");
try {
- new Installation(new SystemChecks(), homeDir, new Properties());
+ new Installation(new MinimumViableEnvironment(), homeDir, new Properties());
fail();
} catch (IllegalStateException e) {
assertThat(e.getMessage()).startsWith("Property 'sonar.path.data' is not valid, directory does not exist: " + dataDir.getAbsolutePath());
try {
FileUtils.touch(dataDir);
- new Installation(new SystemChecks(), homeDir, new Properties());
+ new Installation(new MinimumViableEnvironment(), homeDir, new Properties());
fail();
} catch (IllegalStateException e) {
assertThat(e.getMessage()).startsWith("Property 'sonar.path.data' is not valid, not a directory: " + dataDir.getAbsolutePath());
FileUtils.forceMkdir(webDir);
FileUtils.forceMkdir(logsDir);
- Installation installation = new Installation(new SystemChecks(), homeDir, new Properties());
+ Installation installation = new Installation(new MinimumViableEnvironment(), homeDir, new Properties());
assertThat(installation.prop("sonar.jdbc.username")).isEqualTo("angela");
}
}
+++ /dev/null
-/*
- * SonarQube, open source software quality management tool.
- * Copyright (C) 2008-2014 SonarSource
- * mailto:contact AT sonarsource DOT com
- *
- * SonarQube is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or (at your option) any later version.
- *
- * SonarQube is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-package org.sonar.application;
-
-import org.junit.Test;
-
-import static org.fest.assertions.Assertions.assertThat;
-import static org.fest.assertions.Fail.fail;
-
-public class SystemChecksTest {
-
- @Test
- public void checkJavaVersion() throws Exception {
- SystemChecks checks = new SystemChecks();
-
- // yes, sources are compiled with a supported Java version!
- checks.checkJavaVersion();
-
- checks.checkJavaVersion("1.6.1_b2");
- try {
- checks.checkJavaVersion("1.5.2");
- fail();
- } catch (IllegalStateException e) {
- assertThat(e).hasMessage("Minimal required Java version if 1.6. Got: 1.5.2");
- }
- }
-}
projects / sonarqube.git / commitdiff