Add a new driver for Vault

Will open up possibilities of writing/testing a new castellan
driver in OpenStack

Details on how to run Vault in developer mode is here:
https://www.vaultproject.io/intro/getting-started/dev-server.html
https://www.vaultproject.io/docs/concepts/dev-server.html

README.rst

@@ -41,6 +41,7 @@ Pifpaf currently supports:
 * `S3rver`_
 * `MongoDB`_
 * `OpenStack Swift`_
+* `Vault`_
 
 .. _Consul: https://www.consul.io/
 .. _PostgreSQL: http://postgresql.org
@@ -61,6 +62,7 @@ Pifpaf currently supports:
 .. _S3rver: https://www.npmjs.com/package/s3rver
 .. _MongoDB: https://www.mongodb.com
 .. _OpenStack Swift: https://docs.openstack.org/developer/swift/
+.. _Vault: https://www.vaultproject.io/
 
 Usage
 =====

pifpaf/drivers/vault.py

@@ -0,0 +1,52 @@
+# 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 uuid
+
+from pifpaf import drivers
+
+
+class VaultDriver(drivers.Driver):
+    DEFAULT_ROOT_TOKEN_ID = str(uuid.uuid4())
+    DEFAULT_LISTEN_ADDRESS = "127.0.0.1:8200"
+
+    def __init__(self, root_token_id=DEFAULT_ROOT_TOKEN_ID,
+                 listen_address=DEFAULT_LISTEN_ADDRESS, **kwargs):
+        super(VaultDriver, self).__init__(**kwargs)
+        self.root_token_id = root_token_id
+        self.listen_address = listen_address
+
+    @classmethod
+    def get_parser(cls, parser):
+        parser.add_argument("--root-token-id",
+                            default=cls.DEFAULT_ROOT_TOKEN_ID,
+                            help="root token for vault")
+        parser.add_argument("--listen-address",
+                            default=cls.DEFAULT_LISTEN_ADDRESS,
+                            help="listen address for vault")
+        return parser
+
+    def _setUp(self):
+        super(VaultDriver, self)._setUp()
+        c, _ = self._exec(["vault",
+                           "server",
+                           "-dev",
+                           "-dev-root-token-id=" + self.root_token_id,
+                           "-dev-listen-address=" + self.listen_address],
+                          wait_for_line="Vault server started!")
+
+        self.addCleanup(self._kill, c)
+
+        self.putenv("ROOT_TOKEN", self.root_token_id)
+        self.putenv("VAULT_ADDR", "http://%s" % self.listen_address)
+        self.putenv("URL", "http://%s" % self.listen_address)

pifpaf/tests/test_drivers.py

@@ -44,6 +44,7 @@
 from pifpaf.drivers import redis
 from pifpaf.drivers import s3rver
 from pifpaf.drivers import swift
+from pifpaf.drivers import vault
 from pifpaf.drivers import zookeeper
 
 
@@ -155,6 +156,17 @@ def test_memcached(self):
                          os.getenv("PIFPAF_URL"))
         self.assertEqual(str(port), os.getenv("PIFPAF_MEMCACHED_PORT"))
 
+    @testtools.skipUnless(spawn.find_executable("vault"),
+                          "vault not found")
+    def test_vault(self):
+        listen_address = "localhost:5049"
+        self.useFixture(vault.VaultDriver(listen_address=listen_address))
+        self.assertEqual("http://%s" % listen_address,
+                         os.getenv("PIFPAF_URL"))
+        self.assertEqual("http://%s" % listen_address,
+                         os.getenv("PIFPAF_VAULT_ADDR"))
+        self.assertTrue(len(os.getenv("PIFPAF_ROOT_TOKEN")) > 0)
+
     @testtools.skipUnless(spawn.find_executable("fakes3"),
                           "fakes3 not found")
     def test_fakes3(self):

setup.cfg

@@ -53,6 +53,7 @@ pifpaf.daemons =
     redis = pifpaf.drivers.redis:RedisDriver
     s3rver = pifpaf.drivers.s3rver:S3rverDriver
     zookeeper = pifpaf.drivers.zookeeper:ZooKeeperDriver
+    vault = pifpaf.drivers.vault:VaultDriver
 
 console_scripts =
     pifpaf = pifpaf.__main__:main