Merge pull request #757 from siemens/feat/updateViewScript

feat(updateViewScript): Script to update Views.

tested-by:michael.c.jaeger@siemens.com

scripts/migrations/015_update_fullmyprojects_view.py

@@ -0,0 +1,98 @@
+#!/usr/bin/python
+# -----------------------------------------------------------------------------
+# Copyright Siemens AG, 2019. Part of the SW360 Portal Project.
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+# This is a manual database migration script. It is assumed that a
+# dedicated framework for automatic migration will be written in the
+# future. When that happens, this script should be refactored to conform
+# to the framework's prerequisites to be run by the framework. For
+# example, server address and db name should be parameterized, the code
+# reorganized into a single class or function, etc.
+# -----------------------------------------------------------------------------
+
+import time
+import couchdb
+import json
+from webbrowser import get
+
+# ---------------------------------------
+# constants
+# ---------------------------------------
+
+DRY_RUN = True
+
+COUCHSERVER = "http://localhost:5984/"
+DBNAME = 'sw360db'
+
+couch = couchdb.Server(COUCHSERVER)
+db = couch[DBNAME]
+
+doc_id = "_design/Project"
+nested_field_key = ["views", "fullmyprojects", "map"]
+new_value = "function(doc) {\n  if (doc.type == 'project') {\n    var acc = {};\n    if(doc.createdBy)\n      acc[doc.createdBy]=1;\n    if(doc.leadArchitect)\n      acc[doc.leadArchitect]=1;\n    for(var i in doc.moderators) { \n      acc[doc.moderators[i]]=1;\n    }\n    for(var i in doc.contributors) {\n      acc[doc.contributors[i]]=1;\n    }\n    if(doc.projectOwner)\n      acc[doc.projectOwner]=1;\n    if(doc.projectResponsible)\n      acc[doc.projectResponsible]=1;\n    for(var i in doc.securityResponsibles) {\n      acc[doc.securityResponsibles[i]]=1;\n    }\n    for(var i in acc){\n      emit(i,doc);\n    }\n  }\n}"
+
+# ---------------------------------------
+# functions
+# ---------------------------------------
+
+def run():
+    log = {}
+    log['docId'] = doc_id
+    print 'Getting Document by ID : ' + doc_id
+    doc = db.get(doc_id, None)
+    if doc is not None:
+        print 'Received document.'
+        old_value = updateValue(doc, nested_field_key, new_value)
+        if old_value is not None:
+            field_to_update = "->"
+            field_to_update = field_to_update.join(nested_field_key)
+
+            print 'Field to update : ' + field_to_update
+            print 'Old Value : ' + old_value
+            print 'Updating Value for Document : ' + doc_id
+
+            log['field_to_update'] = field_to_update
+            log['old_value'] = old_value
+            log['new_value'] = new_value
+            if not DRY_RUN:
+                db.save(doc)
+        else:
+            print 'Key Not Found.'
+            log['result'] = 'Key Not Found.'
+    else:
+        print 'No document found with this ID.'
+        log['result'] = 'No document found with this ID.'
+
+
+    resultFile = open('015_migration.log', 'w')
+    json.dump(log, resultFile, indent = 4)
+    resultFile.close()
+
+    print '\n'
+    print '------------------------------------------'
+    print 'Please check log file "015_migration.log" in this directory for details'
+    print '------------------------------------------'
+
+def updateValue(input_dictionary, nested_key, new_value):
+    dictionary_value = input_dictionary
+    for key in nested_key[:-1]:
+        dictionary_value = dictionary_value.get(key, None)
+        if dictionary_value is None:
+            return None
+    last_key = nested_key[-1]
+    old_value = dictionary_value.get(last_key, None)
+    dictionary_value[last_key] = new_value
+
+    return old_value
+
+# --------------------------------
+
+startTime = time.time()
+run()
+print '\nTime of migration: ' + "{0:.2f}".format(time.time() - startTime) + 's'

scripts/migrations/README.md

@@ -36,6 +36,9 @@ To migrate it is recommended to do this in the following order:
 ### 5.x.x -> 6.0.0
 - `014_migrate_fossology_rest.py`
 
+### 6.0.0 -> 7.0.0
+- `015_update_fullmyprojects_view.py`
+
 ## Optional usage
 - `009_overwrite_release_name_with_component_name.py`
 - `010_repair_missing_vendorId_links_in_releases.py`

scripts/utilities/002_update_view.py

@@ -0,0 +1,98 @@
+#!/usr/bin/python
+# -----------------------------------------------------------------------------
+# Copyright Siemens AG, 2019. Part of the SW360 Portal Project.
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+# This is a manual database migration script. It is assumed that a
+# dedicated framework for automatic migration will be written in the
+# future. When that happens, this script should be refactored to conform
+# to the framework's prerequisites to be run by the framework. For
+# example, server address and db name should be parameterized, the code
+# reorganized into a single class or function, etc.
+# -----------------------------------------------------------------------------
+
+import time
+import couchdb
+import json
+from webbrowser import get
+
+# ---------------------------------------
+# constants
+# ---------------------------------------
+
+DRY_RUN = True
+
+COUCHSERVER = "http://localhost:5984/"
+DBNAME = 'sw360db'
+
+couch = couchdb.Server(COUCHSERVER)
+db = couch[DBNAME]
+
+doc_id = "document_id"
+nested_field_key = ["key1", "nestedKey2", "nestedKey3"]
+new_value = "new_value"
+
+# ---------------------------------------
+# functions
+# ---------------------------------------
+
+def run():
+    log = {}
+    log['docId'] = doc_id
+    print 'Getting Document by ID : ' + doc_id
+    doc = db.get(doc_id, None)
+    if doc is not None:
+        print 'Received document.'
+        old_value = updateValue(doc, nested_field_key, new_value)
+        if old_value is not None:
+            field_to_update = "->"
+            field_to_update = field_to_update.join(nested_field_key)
+
+            print 'Field to update : ' + field_to_update
+            print 'Old Value : ' + old_value
+            print 'Updating Value for Document : ' + doc_id
+
+            log['field_to_update'] = field_to_update
+            log['old_value'] = old_value
+            log['new_value'] = new_value
+            if not DRY_RUN:
+                db.save(doc)
+        else:
+            print 'Key Not Found.'
+            log['result'] = 'Key Not Found.'
+    else:
+        print 'No document found with this ID.'
+        log['result'] = 'No document found with this ID.'
+
+
+    resultFile = open('002_utilities.log', 'w')
+    json.dump(log, resultFile, indent = 4)
+    resultFile.close()
+
+    print '\n'
+    print '------------------------------------------'
+    print 'Please check log file "002_utilities.log" in this directory for details'
+    print '------------------------------------------'
+
+def updateValue(input_dictionary, nested_key, new_value):
+    dictionary_value = input_dictionary
+    for key in nested_key[:-1]:
+        dictionary_value = dictionary_value.get(key, None)
+        if dictionary_value is None:
+            return None
+    last_key = nested_key[-1]
+    old_value = dictionary_value.get(last_key, None)
+    dictionary_value[last_key] = new_value
+
+    return old_value
+
+# --------------------------------
+
+startTime = time.time()
+run()
+print '\nTime of migration: ' + "{0:.2f}".format(time.time() - startTime) + 's'

scripts/utilities/README.md

@@ -16,9 +16,12 @@ To execute it is recommended to do this in the following order:
       1. `fieldName` = *"field_to_be_migrated"*
       2. `oldValue` = *"old_value"*
       3. `newValue` = *"new_value"*
+- `002_update_view.py`
+    - Script to update a view for a design document.
+      Following variables needs to be updated based on the requirement
+      1. `doc_id` = *"document_id"*
+      2. `nested_field_key` = *"field_to_be_updated"*
+      3. `newValue` = *"new_value"*
 
 ## Run the scripts for a database not running on localhost
 tbd.
-
-## Run the scripts within docker
-You can use the bash script `./dockerized-migration-runner.sh` to run the scripts wrapped within a docker container.