Moving neokit here to be generally accessable to everyone

Author: Zhen

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -0,0 +1,79 @@
+# Neo4j Driver Toolkit
+
+Tools for downloading, managing and testing Neo4j servers.
+
+- `neoget` - download and unarchive Neo4j server packages
+- `neoctl` - start and stop Neo4j servers and update default server password
+- `neorun` - start and stop a Neo4j server with guarantee of server fully started and stopped
+
+
+## Neoget
+Neoget is a download script for fetching Neo4j server packages. To download the latest nightly version of Neo4j, simply use:
+```
+python neoget.py
+```
+If successful, the downloaded package would be unarchived immediately following the download.
+
+To install a specific Neo4j package version, use `-v` to specify the version:
+```
+python neoget.py -v 3.0.1
+```
+
+The `-n` option can be used to carry out a download for the latest nightly version of Neo4j.
+```
+python neoget.py -n 3.0
+```
+Then the archive with the version `3.0-NIGHTLY` would be downloaded to local disk
+
+Alternatively, a url could also be used with option `-l` to directly download the Neo4j specified by the url
+```
+python neoget.py -l http://alpha.neohq.net/dist/neo4j-enterprise-3.0-NIGHTLY-unix.tar.gz
+```
+
+For a full help page, use `-h`:
+```
+python neoget.py -h
+```
+
+## Neoctl
+Neoctl is a controller for start and stop Neo4j packages. It also provides a method to update default neo4j password.
+
+To start a server, use the `start` command:
+```
+python neoctl.py --start=neo4j
+```
+
+Similarly, to stop a server, use the `stop` command:
+```
+python neoctl.py --stop=neo4j
+```
+
+To change the default passowrd of a Neo4j server, simply use
+```
+python neoctrl.py --update-passowrd=s3cr3tP4ssw0rd
+```
+
+
+## Neorun
+Neorun provides commands to start and stop a Neo4j server with the guarantee that the server is fully started and stopped when the script returns.
+The start command also exposes a command to download and install a specific Neo4j server if no Neo4j found locally,
+as well as an option to change the default server password after the start.
+
+To start a Neo4j server, simply use the following command:
+```
+python neorun.py --start=neo4j
+```
+When the script returns, then the server is fully ready for any database tasks.
+
+If no Neo4j server is found in path `./neo4j`, then the default Neo4j server version used in `neoget.py` will be downloaded and installed to `./neo4j`.
+To specify other versions to download when a Neo4j is absent, use `-v`, `-n`, `-l` in a similar way as they are defined in `neoget.py`:
+```
+python neorun.py --start=neo4j -n 3.1 -p TOUFU
+```
+In the example above, the `-p` option is used to change the default Neo4j password after the server is ready.
+
+For stopping the server, simply use the `stop` command:
+```
+python neorun.py --stop=neo4j
+```
+

neoctl.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) 2002-2016 "Neo Technology,"
+# Network Engine for Objects in Lund AB [http://neotechnology.com]
+#
+# This file is part of Neo4j.
+#
+# 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.
+
+"""
+Usage: neoctl.py <cmd=arg>
+ --start=path/to/neo4j/home : start neo4j
+ --stop=path/to/neo4j/home : stop neo4j
+ --update-password=s3cr3tP4ssw0rd : update the neo4j password
+ -h : show this help message
+
+Example: neoctl.py --start=./neo4j-enterprise-3.0.0-M01
+ neoctl.py -h
+"""
+
+from __future__ import print_function
+from json import dumps as json_dumps
+from base64 import b64encode
+from sys import argv, exit
+from os import name
+import getopt
+from subprocess import call, Popen, PIPE
+try:
+ from urllib.request import Request, urlopen, HTTPError
+except ImportError:
+ from urllib2 import Request, urlopen, HTTPError
+
+is_windows = (name == 'nt')
+
+
+def main():
+ if len(argv) <= 1:
+ print_help()
+ exit()
+ try:
+ opts, args = getopt.getopt(argv[1:], "h", ["start=", "stop=", "update-password="])
+ except getopt.GetoptError as err:
+ print(str(err))
+ print_help()
+ exit_code = 2
+ else:
+ exit_code = 0
+ for opt, arg in opts:
+ if opt == '-h':
+ print_help()
+ elif opt == "--start":
+ exit_code = neo4j_start(neo4j_home=arg) or 0
+ elif opt == "--stop":
+ exit_code = neo4j_stop(neo4j_home=arg) or 0
+ elif opt == "--update-password":
+ exit_code = neo4j_update_password("localhost", 7474, "neo4j", "neo4j", new_password=arg) or 0
+ else:
+ print("Bad option %s" % opt)
+ exit_code = 1
+ if exit_code != 0:
+ break
+ exit(exit_code)
+
+
+def neo4j_start(neo4j_home):
+ if is_windows:
+ return powershell([neo4j_home + '/bin/neo4j.bat install-service;', neo4j_home + '/bin/neo4j.bat start'])
+ else:
+ call([neo4j_home + "/bin/neo4j", "start"])
+
+
+def neo4j_stop(neo4j_home):
+ if is_windows:
+ return powershell([neo4j_home + '/bin/neo4j.bat stop;', neo4j_home + '/bin/neo4j.bat uninstall-service'])
+ else:
+ call([neo4j_home+"/bin/neo4j", "stop"])
+
+
+def neo4j_update_password(host, http_port, user, password, new_password):
+ request = Request("http://%s:%s/user/neo4j/password" % (host, http_port),
+ json_dumps({"password": new_password}, ensure_ascii=True).encode("utf-8"),
+ {"Authorization": "Basic " + b64encode((user + ":" + password).encode("utf-8")).decode("ascii"),
+ "Content-Type": "application/json"})
+ try:
+ f = urlopen(request)
+ f.read()
+ f.close()
+ except HTTPError as error:
+ raise RuntimeError("Cannot update password [%s]" % error)
+
+
+def powershell(cmd):
+ cmd = ['powershell.exe'] + cmd
+ p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+ out, err = p.communicate()
+ return_code = p.wait()
+ print(out)
+ print(err)
+ return return_code
+
+
+def print_help():
+ print(__doc__)
+
+if __name__ == "__main__":
+ main()

neoget.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) 2002-2016 "Neo Technology,"
+# Network Engine for Objects in Lund AB [http://neotechnology.com]
+#
+# This file is part of Neo4j.
+#
+# 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.
+
+"""
+Usage: neoget.py <cmd> [arg]
+ -v neo4j-version: download this specific neo4j enterprise version
+ -n neo4j-version: download this neo4j enterprise nightly version
+ -l download-url : download neo4j provided by this url
+ -h : show this help message
+
+Example: neoget.py -v 2.3.1
+ neoget.py -h
+ neoget.py -n 3.0
+"""
+from __future__ import print_function
+from urllib import urlretrieve
+from sys import argv, stdout, exit
+import getopt
+from os import path, name
+from zipfile import ZipFile
+from tarfile import TarFile
+from urlparse import urlparse
+
+DIST = "http://dist.neo4j.org"
+NIGHTLY_DIST = "http://alpha.neohq.net/dist"
+NIGHTLY30_UNIX_URL = "http://alpha.neohq.net/dist/neo4j-enterprise-3.0-NIGHTLY-unix.tar.gz"
+NIGHTLY30_WIN_URL = "http://alpha.neohq.net/dist/neo4j-enterprise-3.0-NIGHTLY-windows.zip"
+
+is_windows = (name == 'nt')
+
+
+def main():
+ try:
+ opts, args = getopt.getopt(argv[1:], "hv:s:l:")
+ except getopt.GetoptError as err:
+ print(str(err))
+ print_help()
+ exit()
+
+ archive_url, archive_name = neo4j_default_archive()
+
+ for opt, arg in opts:
+ if opt == '-h':
+ print_help()
+ exit()
+ elif opt in ('-v', '-n', '-l'):
+ archive_url, archive_name = neo4j_archive(opt, arg)
+ try:
+ download(archive_url, archive_name)
+ finally:
+ ret = 0 if path.exists(archive_name) else 1
+ exit(ret)
+
+
+def neo4j_default_archive():
+ archive_url = NIGHTLY30_WIN_URL if is_windows else NIGHTLY30_UNIX_URL
+ archive_name = path.split(urlparse(archive_url).path)[-1]
+ return archive_url, archive_name
+
+
+def neo4j_archive(opt, arg):
+ archive_url, archive_name = '', ''
+
+ if opt == '-v':
+ if is_windows:
+ archive_name = "neo4j-enterprise-%s-windows.zip" % arg
+ else:
+ archive_name = "neo4j-enterprise-%s-unix.tar.gz" % arg
+ archive_url = "%s/%s" % (DIST, archive_name)
+ elif opt == '-n':
+ if is_windows:
+ archive_name = "neo4j-enterprise-%s-NIGHTLY-windows.zip" % arg
+ else:
+ archive_name = "neo4j-enterprise-%s-NIGHTLY-unix.tar.gz" % arg
+ archive_url = "%s/%s" % (NIGHTLY_DIST, archive_name)
+ elif opt == '-l':
+ archive_url = arg
+ archive_name = path.split(urlparse(archive_url).path)[-1]
+ return archive_url, archive_name
+
+
+def download(archive_url, archive_name, extract_to_path='.'):
+ stdout.write("Downloading %s...\n" % archive_url)
+ urlretrieve(archive_url, archive_name)
+
+ if archive_name.endswith('.zip'):
+ stdout.write("Unzipping %s...\n" % archive_name)
+ zip_ref = ZipFile(archive_name, 'r')
+ zip_ref.extractall(extract_to_path)
+ zip_ref.close()
+ elif archive_name.endswith('.tar.gz'):
+ stdout.write("Unarchiving %s...\n" % archive_name)
+ tar_ref = TarFile.open(archive_name)
+ tar_ref.extractall(extract_to_path)
+ untar_folder=tar_ref.getnames()[0]
+ tar_ref.close()
+ return untar_folder
+
+
+def print_help():
+ print(__doc__)
+
+
+if __name__ == "__main__":
+ main()