SERVER-33892 Separate test_commands_enabled library

1 files changed, 59 insertions, 0 deletions

diff --git a/src/mongo/db/commands/test_commands_enabled.h b/src/mongo/db/commands/test_commands_enabled.h
new file mode 100644
index 00000000000..633c18153b8
--- /dev/null
+++ b/src/mongo/db/commands/test_commands_enabled.h
@@ -0,0 +1,59 @@
+/**
+ * Copyright (C) 2018 MongoDB Inc.
+ *
+ *    This program is free software: you can redistribute it and/or  modify
+ *    it under the terms of the GNU Affero General Public License, version 3,
+ *    as published by the Free Software Foundation.
+ *
+ *    This program 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 Affero General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Affero General Public License
+ *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ *    As a special exception, the copyright holders give permission to link the
+ *    code of portions of this program with the OpenSSL library under certain
+ *    conditions as described in each individual source file and distribute
+ *    linked combinations including the program with the OpenSSL library. You
+ *    must comply with the GNU Affero General Public License in all respects
+ *    for all of the code used other than as permitted herein. If you modify
+ *    file(s) with this exception, you may extend this exception to your
+ *    version of the file(s), but you are not obligated to do so. If you do not
+ *    wish to do so, delete this exception statement from your version. If you
+ *    delete this exception statement from all source files in the program,
+ *    then also delete it in the license file.
+ */
+
+#pragma once
+
+namespace mongo {
+
+/**
+ * If true, then testing commands are available. Defaults to false.
+ *
+ * Testing commands should conditionally register themselves by consulting this flag:
+ *
+ *     MONGO_INITIALIZER(RegisterMyTestCommand)(InitializerContext* context) {
+ *         if (getTestCommandsEnabled()) {
+ *             // Leaked intentionally: a Command registers itself when constructed.
+ *             new MyTestCommand();
+ *         }
+ *         return Status::OK();
+ *     }
+ *
+ * To make testing commands available by default, change the value to true before running any
+ * mongo initializers:
+ *
+ *     int myMain(int argc, char** argv, char** envp) {
+ *         setTestCommandsEnabled(true);
+ *         ...
+ *         runGlobalInitializersOrDie(argc, argv, envp);
+ *         ...
+ *     }
+ */
+bool getTestCommandsEnabled();
+void setTestCommandsEnabled(bool b);
+
+}  // namespace mongo