created script to email the audit log #491
Conversation
|
@BLema , I forgot to mention that, because a registry record was added, an upgrade will be required. See upgrade 2 6 27 for the standard pattern when writing upgrade code. there are about 4 or 5 files that need to be created/editted for this |
There was a problem hiding this comment.
after requested changes are made, at minimum, flake8 linter will need to be run, and code changes it recommends need to be made. Running the command flake8 castle.cms from the root directory will probably be sufficient, although you may need to pip install flake8 first. There may be errors it complains about that we don't care about. you can look at our specific flake8 config here https://github.com/castlecms/castle.cms/blob/master/setup.cfg, and you can see the automated tests that are run on every commit here: https://github.com/castlecms/castle.cms/blob/master/.travis.yml. you can also run our tests locally before committing with the command bin/test, and there are a bunch of config options that sometimes come in handy, which you can find with bin/test --help. Also, for the flake8 config, there are slightly different command-line args that can mimic the config in setup.cfg. For example, flake8 --max-line-length=110 castle.cms
castle/cms/upgrades.zcml
Outdated
| @@ -464,4 +464,13 @@ | |||
| handler=".upgrades.upgrade_2_6_31" | |||
| profile="castle.cms:default" | |||
| /> | |||
|
|
|||
There was a problem hiding this comment.
needs a register profile here as well
| @@ -0,0 +1,8 @@ | |||
| <?xml version="1.0"?> | |||
There was a problem hiding this comment.
this file needs to be renamed
| @@ -0,0 +1,4 @@ | |||
| <?xml version="1.0"?> | |||
There was a problem hiding this comment.
this file needs to be renamed
castle/cms/cron/_email_audit.py
Outdated
|
|
||
| def run_query(): | ||
| registry = getToolByName(app['Castle'], 'portal_registry') | ||
| # index_name = 'castle' |
There was a problem hiding this comment.
commented lines can be removed
castle/cms/cron/_email_audit.py
Outdated
| index_name = audit.get_index_name() | ||
| es = ESConnectionFactoryFactory(registry)() | ||
|
|
||
| #import pdb; pdb.set_trace() |
There was a problem hiding this comment.
commented lines can be removed
castle/cms/upgrades.zcml
Outdated
| name="2_6_32" | ||
| title="CastleCMS upgrade to 2.6.32 profile" | ||
| directory="profiles/2_6_32" | ||
| description="" |
There was a problem hiding this comment.
probably a good idea to throw in a short description like 2632 adds script that does something with the audit log
| @@ -0,0 +1,10 @@ | |||
| from Products.CMFCore.utils import getToolByName | |||
There was a problem hiding this comment.
A month or so back, I refactored how we do upgrades to save some code and files. For a "standard" upgrade like this, this file is now unnecessary, but we do need a line in castle/cms/upgrades/init.py for 2_6_32.
|
if you click on details above, next to continuous-integration/travis-ci/pr or continuous-integration/travis-ci/push (red x indicates something in the ci tests failed), you should be able to see what specifically went wrong and where. In this case all 4 build jobs failed, and following the links, you can look through the build jobs, which after a bunch of boilerplate logging show |
|
now just flake8 again |
|
I'm still seeing 3 flake8 issues: the first and third aren't actually problems, since some magic makes 'app' available as this script is run. But flake8 doesn't know that, so we can tell flake8 to ignore the issue by putting |
castle/cms/cron/_email_audit.py
Outdated
|
|
||
|
|
||
| def run_query(): | ||
| registry = getToolByName(app['Castle'], 'portal_registry') # noqa: F821 |
There was a problem hiding this comment.
in order to not create a different flake8 error, inline comments need to have exactly 2 spaces before comment
castle/cms/cron/_email_audit.py
Outdated
| return html | ||
|
|
||
|
|
||
| def run(app): # noqa: F821 |
There was a problem hiding this comment.
this wasn't where the error was - a parameter will always be defined, even if the value is None
castle/cms/cron/_email_audit.py
Outdated
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| run(app) |
There was a problem hiding this comment.
this was where app was undefined
katiewiessfelt
force-pushed
the
BL/email_audit
branch
from
150eb28 to
6485eae
Compare
Created a script for sending the day's audit log to a list of recipients created on the Castle CMS settings page.