feat: add manage-scripts to switch system modules value #6532

akshat0047 · 2019-10-17T17:58:04Z

Fixes #6525 @prateekj117 @iamareebjamal

Short description of what this resolves:

This adds a manage-script which helps the tester to switch any system module On/Off through command line

Changes proposed in this pull request:

Added a manage command with the name switch
switch command provides the option to switch a specific module or all of them by specifying module_name or all
Updated documentation in readme.md under the 'Testing' heading

Checklist

I have read the Contribution & Best practices Guide and my PR follows them.
My branch is up-to-date with the Upstream development branch.
The unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

houndci-bot · 2019-10-17T17:58:09Z

manage.py

+            time.sleep(1)
+            setattr(Module.query.first(),system,not value)
+            db.session.commit()
+            print("Module %s turned %s" %(system,convey[str(not value)]))


missing whitespace after ','
missing whitespace around operator

houndci-bot · 2019-10-17T17:58:09Z

manage.py

+        if system in keys:
+            value = getattr(Module.query.first(),system)
+            time.sleep(1)
+            setattr(Module.query.first(),system,not value)


missing whitespace after ','

houndci-bot · 2019-10-17T17:58:10Z

manage.py

+            print("Module %s turned %s" %(key,convey[str(not value)]))
+    else:
+        if system in keys:
+            value = getattr(Module.query.first(),system)


missing whitespace after ','

houndci-bot · 2019-10-17T17:58:10Z

manage.py

+            time.sleep(1)
+            setattr(Module.query.first(),key,not value)
+            db.session.commit()
+            print("Module %s turned %s" %(key,convey[str(not value)]))


missing whitespace after ','
missing whitespace around operator

houndci-bot · 2019-10-17T17:58:10Z

manage.py

+        for key in keys:
+            value = getattr(Module.query.first(),key)
+            time.sleep(1)
+            setattr(Module.query.first(),key,not value)


missing whitespace after ','

houndci-bot · 2019-10-17T17:58:11Z

manage.py

+    convey = {'True':'On','False':'Off'}
+    if system == 'all':
+        for key in keys:
+            value = getattr(Module.query.first(),key)


missing whitespace after ','

houndci-bot · 2019-10-17T17:58:11Z

manage.py

+def switch(system):
+    import time
+    keys = [i.name for i in Module.__table__.columns][1:]
+    convey = {'True':'On','False':'Off'}


missing whitespace after ','
missing whitespace after ':'

houndci-bot · 2019-10-17T17:58:11Z

manage.py

@@ -35,6 +36,25 @@ def add_event_identifier():
        event.identifier = get_new_event_identifier()
        save_to_db(event)

+@manager.command


expected 2 blank lines, found 1

codecov · 2019-10-17T18:04:24Z

Codecov Report

Merging #6532 into development will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           development    #6532   +/-   ##
============================================
  Coverage        65.11%   65.11%           
============================================
  Files              295      295           
  Lines            15284    15284           
============================================
  Hits              9952     9952           
  Misses            5332     5332

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d781989...c52c32f. Read the comment docs.

iamareebjamal · 2019-10-17T18:40:30Z

README.md

+
+-   Before you join development, please set up the system on your local machine and go through the application completely. Press on any link/button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
+-   Test the application on your machine and explore the admin area. The test deployment on Heroku will not give you access to the admin section, where you can switch on/off modules, e.g. ticketing and add keys for services, e.g. storage on S3.
+-   If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.


All changes in README are unrelated to the open issue. Please stick to the changes proposed in the PR. Open another issue of you want to fix other things

I didn't change this, must be a result of some rebase/squashing/stashing, fixing it

iamareebjamal · 2019-10-17T18:41:34Z

manage.py

@@ -36,6 +37,26 @@ def add_event_identifier():
        save_to_db(event)


+@manager.command
+def switch(system):


See the option below. Rename to module and pass name and on/off as parameters

Implemented, please review

iamareebjamal · 2019-10-17T18:42:09Z

manage.py

+    else:
+        if system in keys:
+            value = getattr(Module.query.first(),system)
+            time.sleep(1)


Is the system so fast that we deliberately need to make it slow? Or is it needed for some reason

I apologize for pushing this as it was making sense with some previous functionality here, similar mistake may not be repeated.

houndci-bot · 2019-10-17T19:47:09Z

manage.py

+def module(name,switch):
+    keys = [i.name for i in Module.__table__.columns][1:]
+    convey = {"on":True, "off":False}
+    if switch not in ['on','off']:


missing whitespace after ','

houndci-bot · 2019-10-17T19:47:10Z

manage.py

+@manager.option('-s', '--switch', dest='switch', default='off')
+def module(name,switch):
+    keys = [i.name for i in Module.__table__.columns][1:]
+    convey = {"on":True, "off":False}


missing whitespace after ':'

houndci-bot · 2019-10-17T19:47:10Z

manage.py

@@ -36,6 +37,27 @@ def add_event_identifier():
        save_to_db(event)


+@manager.option('-n', '--name', dest='name', default='all')
+@manager.option('-s', '--switch', dest='switch', default='off')
+def module(name,switch):


missing whitespace after ','

houndci-bot · 2019-10-17T19:59:39Z

manage.py

+            print("Module %s turned %s" % (name, switch))
+        else:
+            print("Invalid module selected")
+


blank line contains whitespace

manage.py

iamareebjamal · 2019-10-17T21:13:31Z

manage.py

+            db.session.commit()
+            print("Module %s turned %s" % (key, switch))
+    else:
+        if name in keys:


Can be changed to elif

Implemented

Updating...

Updated, consistent with upstream.

prateekj117 · 2019-10-18T08:07:18Z

manage.py

+            db.session.commit()
+            print("Module %s turned %s" % (key, switch))
+    elif name in keys:
+            setattr(Module.query.first(), name, convey[switch])


@akshat0047 Fix indentation here (over-indented). Make it four spaces as used in other parts of the file.

prateekj117 · 2019-10-18T08:09:39Z

manage.py

+            print("Module %s turned %s" % (name, switch))
+    else:
+        print("Invalid module selected")
+


PEP 8: expected 2 blank lines, found 1.

iamareebjamal · 2019-10-18T12:05:57Z

manage.py

+    elif name == 'all':
+        for key in keys:
+            setattr(Module.query.first(), key, convey[switch])
+            db.session.commit()


Move commit to last line instead of commiting in each iteration

Implemented

houndci-bot reviewed Oct 17, 2019

View reviewed changes

iamareebjamal reviewed Oct 17, 2019

View reviewed changes

houndci-bot reviewed Oct 17, 2019

View reviewed changes

iamareebjamal reviewed Oct 17, 2019

View reviewed changes

prateekj117 reviewed Oct 18, 2019

View reviewed changes

iamareebjamal reviewed Oct 18, 2019

View reviewed changes

added manage-scripts to switch system modules value

c52c32f

iamareebjamal approved these changes Oct 18, 2019

View reviewed changes

iamareebjamal changed the title ~~added manage-scripts to switch system modules value~~ feat: add manage-scripts to switch system modules value Oct 18, 2019

auto-label bot added the feature label Oct 18, 2019

iamareebjamal merged commit c873481 into fossasia:development Oct 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add manage-scripts to switch system modules value #6532

feat: add manage-scripts to switch system modules value #6532

akshat0047 commented Oct 17, 2019 •

edited

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

codecov bot commented Oct 17, 2019 •

edited

iamareebjamal Oct 17, 2019

akshat0047 Oct 17, 2019

akshat0047 Oct 17, 2019

iamareebjamal Oct 17, 2019

akshat0047 Oct 17, 2019

akshat0047 Oct 17, 2019

iamareebjamal Oct 17, 2019

akshat0047 Oct 17, 2019

akshat0047 Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

houndci-bot Oct 17, 2019

iamareebjamal Oct 17, 2019

akshat0047 Oct 17, 2019

akshat0047 Oct 17, 2019

akshat0047 Oct 17, 2019

prateekj117 Oct 18, 2019 •

edited

akshat0047 Oct 18, 2019

prateekj117 Oct 18, 2019

akshat0047 Oct 18, 2019

iamareebjamal Oct 18, 2019

akshat0047 Oct 18, 2019

feat: add manage-scripts to switch system modules value #6532

feat: add manage-scripts to switch system modules value #6532

Conversation

akshat0047 commented Oct 17, 2019 • edited

Short description of what this resolves:

Changes proposed in this pull request:

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 17, 2019 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prateekj117 Oct 18, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akshat0047 commented Oct 17, 2019 •

edited

codecov bot commented Oct 17, 2019 •

edited

prateekj117 Oct 18, 2019 •

edited