Add labsstats role to labs-demo

playbooks/library/mongodb_write.py

@@ -0,0 +1,239 @@
+#!/usr/bin/python
+
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = '''
+---
+module: mongodb_write
+short_description: Writes to a MongoDB database.
+description:
+    - Writes to a MongoDB database.
+options:
+    login_user:
+        description:
+            - The username used to authenticate with
+        required: false
+        default: null
+    login_password:
+        description:
+            - The password used to authenticate with
+        required: false
+        default: null
+    login_host:
+        login_host:
+        description:
+            - The host running the database
+        required: false
+        default: localhost
+    login_port:
+        login_port:
+        description:
+            - The port to connect to
+        required: false
+        default: 27017
+    login_database:
+        description:
+            - The database where login credentials are stored
+        required: false
+        default: null
+    database:
+        description:
+            - The name of the database to write to
+        required: true
+    db_object:
+        description:
+            - The name of the mongodb Object in the database you want to write to
+        required: true
+    action:
+        description:
+            - The name of the write action
+        choices: ["insert", "update", "upsert"]
+        requiredL true
+    data:
+        description:
+            - A dictionary of data you want to write to the database
+        required: false
+        default: empty dict
+    filter:
+        description:
+            - A dictionary of writing filters
+        required: false
+        default: empty dict
+'''
+
+import sys
+import os
+import json
+import ast
+try:
+    from pymongo.errors import ConnectionFailure
+    from pymongo.errors import OperationFailure
+    from pymongo import version as PyMongoVersion
+    from pymongo import MongoClient
+except ImportError:
+    try:  # for older PyMongo 2.2
+        from pymongo import Connection as MongoClient
+    except ImportError:
+        pymongo_found = False
+    else:
+        pymongo_found = True
+else:
+    pymongo_found = True
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.pycompat24 import get_exception
+from ansible.module_utils.six.moves import configparser
+from distutils.version import LooseVersion
+
+# =========================================
+# MongoDB module specific support methods.
+#
+
+
+def check_compatibility(module, client):
+    """Check the compatibility between the driver and the database.
+       See: https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#python-driver-compatibility
+    Args:
+        module: Ansible module.
+        client (cursor): Mongodb cursor on admin database.
+    """
+    loose_srv_version = LooseVersion(client.server_info()['version'])
+    loose_driver_version = LooseVersion(PyMongoVersion)
+
+    if loose_srv_version >= LooseVersion('3.2') and loose_driver_version < LooseVersion('3.2'):
+        module.fail_json(msg=' (Note: you must use pymongo 3.2+ with MongoDB >= 3.2)')
+
+    elif loose_srv_version >= LooseVersion('3.0') and loose_driver_version <= LooseVersion('2.8'):
+        module.fail_json(msg=' (Note: you must use pymongo 2.8+ with MongoDB 3.0)')
+
+    elif loose_srv_version >= LooseVersion('2.6') and loose_driver_version <= LooseVersion('2.7'):
+        module.fail_json(msg=' (Note: you must use pymongo 2.7+ with MongoDB 2.6)')
+
+    elif LooseVersion(PyMongoVersion) <= LooseVersion('2.5'):
+        module.fail_json(msg=' (Note: you must be on mongodb 2.4+ and pymongo 2.5+ to use the roles param)')
+
+
+def check_database_found(module, client, db_name):
+	pass
+
+
+def load_mongocnf():
+    config = configparser.RawConfigParser()
+    mongocnf = os.path.expanduser('~/.mongodb.cnf')
+
+    try:
+        config.readfp(open(mongocnf))
+        creds = dict(
+            user=config.get('client', 'user'),
+            password=config.get('client', 'pass')
+        )
+    except (configparser.NoOptionError, IOError):
+        return False
+
+    return creds
+
+
+def insert(module, client, db_name, db_object, data):
+    db = client[db_name]
+    return db[db_object].insert(data)
+
+
+def update_one(module, client, db_name, db_object, row_filter, data):
+    db = client[db_name]
+    return db[db_object].update_one(row_filter, data, upsert=False)
+
+
+def upsert(module, client, db_name, db_object, row_filter, data):
+    db = client[db_name]
+    return db[db_object].update_one(row_filter, data, upsert=True)
+
+# =========================================
+# Module execution.
+#
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            login_user=dict(default=None),
+            login_password=dict(default=None, no_log=True),
+            login_host=dict(default='localhost'),
+            login_port=dict(default='27017'),
+            login_database=dict(default=None),
+            database=dict(required=True, aliases=['db']),
+            db_object=dict(required=True),
+            action=dict(required=True, choices=['insert', 'update', 'upsert']),
+            data=dict(default={}),
+            filter=dict(default={}),
+            )
+        )
+
+    if not pymongo_found:
+        module.fail_json(msg='the python pymongo module is required')
+
+    login_user = module.params['login_user']
+    login_password = module.params['login_password']
+    login_host = module.params['login_host']
+    login_port = module.params['login_port']
+    login_database = module.params['login_database']
+
+    db_name = module.params['database']
+    db_object = module.params['db_object']
+    action = module.params['action']
+
+    data = ast.literal_eval(module.params['data'])
+    row_filter = ast.literal_eval(module.params['filter'])
+    u_content = None
+
+    try:
+        connection_params = {
+            "host": login_host,
+            "port": int(login_port),
+        }
+        client = MongoClient("mongodb://"+login_user+":"+login_password+"@"+login_host+":"+login_port+"/"+db_name)
+
+        # NOTE: this check must be done ASAP.
+        # We don't need to be authenticated.
+        check_compatibility(module, client)
+
+        if login_user is None and login_password is None:
+            mongocnf_creds = load_mongocnf()
+            if mongocnf_creds is not False:
+                login_user = mongocnf_creds['user']
+                login_password = mongocnf_creds['password']
+            elif login_password is None or login_user is None:
+                module.fail_json(msg='when supplying login arguments, both login_user and login_password must be provided')
+
+        if login_user is not None and login_password is not None:
+            client[db_name].authenticate(login_user, login_password, source=login_database)
+
+    except Exception:
+        e = get_exception()
+        module.fail_json(msg='unable to connect to database: %s' % str(e))
+    if action == 'insert':
+        try:
+            raw_content = insert(module, client, db_name, db_object, data)
+        except Exception:
+            e = get_exception()
+            module.fail_json(msg='Unable to insert to database: %s' % str(e))
+
+    elif action == 'update':
+        try:
+            raw_content = update_one(module, client, db_name, db_object, row_filter, data)
+        except Exception:
+            e = get_exception()
+            module.fail_json(msg='Unable to update to database: %s' % str(e))
+    elif action == 'upsert':
+        try:
+            raw_content = upsert(module, client, db_name, db_object, row_filter, data)
+            u_content = raw_content.upserted_id
+        except Exception:
+            e = get_exception()
+            module.fail_json(msg='Unable to upsert to database: %s' % str(e))
+
+    module.exit_json(changed=True, content=str(u_content))
+
+if __name__ == '__main__':
+    main()

roles/labsstats/README.md

@@ -0,0 +1,32 @@
+Labs Stats
+==========
+
+This role updates labs demo stats after each successful run.
+
+Requirements
+------------
+
+Mongodb must already be installed and running at the target server and loaded with the following schema.
+
+```
+{"name": "runs", "count": 0}
+{"name": "unique_users", "count": 0}
+```
+
+To populate the database with the aforementioned schema, please create a new .json file with the above as the content and run
+
+```
+mongoimport --db <database_name> --collection GlobalStats --drop --file ~/path/to/file.json
+```
+
+Role Variables
+--------------
+
+- `labs_username`: The labs username that we want to record in the database (currently pulled from `demo_username`).
+- `db_user`: The database username that has write access to the database.
+- `db_password`: The database user password.
+
+Running the Playbook
+--------------------
+
+`$ ansible-playbook playbooks/prep-demo.yml --ask-become-pass` if become is enabled

roles/labsstats/tasks/main.yml

@@ -0,0 +1,43 @@
+---
+- name: 'Update demo runs count'
+  mongodb_write:
+    login_user: "{{ db_user }}"
+    login_password: "{{ db_password }}"
+    database: labs-stats
+    db_object: 'GlobalStats'
+    action: 'update'
+    filter:
+      name: 'runs'
+    data:
+      $inc:
+        count: 1
+
+- name: 'Update number of runs per user'
+  mongodb_write:
+    login_user: "{{ db_user }}"
+    login_password: "{{ db_password }}"
+    database: labs-stats
+    db_object: 'UserRuns'
+    action: 'upsert'
+    filter:
+      username: "{{ labs_username }}"
+    data:
+      $set:
+        username: "{{ labs_username }}"
+      $inc:
+        count: 1
+  register: upsert_result
+
+- name: 'Update unique user run count'
+  mongodb_write:
+    login_user: "{{ db_user }}"
+    login_password: "{{ db_password }}"
+    database: labs-stats
+    db_object: 'GlobalStats'
+    action: 'update'
+    filter:
+      name: 'unique_users'
+    data:
+      $inc:
+        count: 1
+  when: upsert_result != "None"

roles/labsstats/tests/library

@@ -0,0 +1 @@
+../../../playbooks/library/

roles/labsstats/tests/roles

@@ -0,0 +1 @@
+../../../roles

roles/labsstats/tests/test_with_ssh_connection_to_db.yml

@@ -0,0 +1,5 @@
+---
+- name: "Update stats"
+  hosts: dbserver
+  roles:
+  - role: labsstats