level12 / keg-app-cookiecutter Goto Github PK

https://github.com/level12/pai-tangerine/commit/28e58a23cd0e6cfef1817ff3e1f77cc4fb6a342a#diff-7f70f0b7852e2b6ee8b91c3ec2c081c4R4

This CELERY config is needed up in the DevProfile.

• Make an alert demo view/page: https://github.com/level12/pai-tangerine/commit/28e58a23cd0e6cfef1817ff3e1f77cc4fb6a342a#diff-46deeff98d9e077a346ddde924a376f9R29
• Turn on dismissible alerts: https://github.com/level12/pai-tangerine/commit/28e58a23cd0e6cfef1817ff3e1f77cc4fb6a342a#diff-7f70f0b7852e2b6ee8b91c3ec2c081c4R12
• Adjust styles to make a bit slimmer: https://github.com/level12/pai-tangerine/commit/28e58a23cd0e6cfef1817ff3e1f77cc4fb6a342a#diff-b534082cb07dce2b668f3bb78be2b181

https://level12.atlassian.net/wiki/spaces/devs/blog/2018/07/06/817430529/Sentry+Slack+updates

See RB for an example.

The cookiecutter includes three example models (Blog, Comment, and User), but no matching alembic migration files.

A migration for the User model, at least, would be a handy addition to the cookiecutter.

Or add it in Keg. Example:

https://github.com/level12/agari-adm/commit/203445a57e69a3c716327a794f885fe4fdaecee3

# Config specific to WSGI workers
uwsgi_config = {
    # Don't log to stdout or uwsgi picks it up and that gets sent to syslog too resulting in double
    # the log volume with no benefit.
    'KEG_LOG_STREAM_ENABLED': False
}

It stops all output when running celery workers locally.

• https://github.com/level12/racebetter/blob/master/racebetter/libs/alembic.py
• https://github.com/level12/racebetter/blob/master/alembic/env.py#L11
  • I think we could auto-detect the presence of the app and bootstrap if not present
• https://github.com/level12/racebetter/blob/master/racebetter/tests/migrate/test_event_ts_run_remodel.py

I'm currently using the circleci/python:3.X images to run our tests. I did it because CircleCI caches Docker images per physical host and our Level 12 images aren't used much, so most of the time, our image has to be pulled. But, the CircleCi images are usually cached, so the tests run much faster.

But, we build our images with some libraries that our apps need, so this may not be sufficient. If it's not sufficient, then maybe we should build our python Docker images off of the CircleCi ones so that most of the layers that need to be pulled are cached.

See RaceBetter for an example.

refs: https://github.com/level12/board-devops/issues/25

Should probably put GridView and company in Keg Elements and then put example usage in this cookiecutter:

class GridView(AuthenticatedView):
    grid_cls = None
    template = 'grid-view.html'
    title = None

    def get(self):
        return self.render_grid()

    def render_grid(self):
        if self.grid_cls is None:
            raise NotImplementedError(
                'You must set {}.grid_cls to render a grid'.format(self.__class__.__name__)
            )

        g = self.grid_cls()
        g.apply_qs_args()

        if hasattr(self, 'setup_grid'):
            self.setup_grid(g)

        if g.export_to == 'xls':
            if g.xls is None:
                raise DependencyError('The xlwt library has to be installed for Excel export.')
            raise ImmediateResponse(g.xls.as_response())

        template_args = {
            'grid': g,
            'title': self.title,
        }

        return flask.render_template(self.template, **template_args)

The example above is from RaceBetter.

uwsgi docs give this example for Celery:

[uwsgi]
master = true
socket = :3031
smart-attach-daemon = /tmp/celery.pid celery -A tasks worker --pidfile=/tmp/celery.pid

See: http://uwsgi-docs.readthedocs.io/en/latest/AttachingDaemons.html

https://github.com/level12/racebetter/pull/621/files#diff-1bc504553fca0edd0710c40af4c182f4R21

the default class in config.py should be DefaultProfile not Default.

ATech integration of Keg-Login:

• Initial commit: https://github.com/level12/atech-imp/commit/cf890bbd1d485de41b2ba42acac5a977839ce3e7
• Fully support password reset https://github.com/level12/atech-imp/commit/7ea4a0c2f7c280be3cc414ffcde19bb0f7d6b993
• Allow admins to set user passwords directly and avoid email requirement: level12/atech-imp@a73bb797166b698ef10fd9125e8569ce50667e66
• Add base template for Keg-Login views: level12/atech-imp@d037ac94d85924b4ae6bbcbe1bdd74f70a6cd59b
• Fix login and lock page titles: level12/atech-imp@9fd8bde196d6537551246004eeacc21d529941ee

For reference: https://github.com/level12/pai-tangerine/commit/28e58a23cd0e6cfef1817ff3e1f77cc4fb6a342a#diff-1825cbab77686462fdec379dc145b2fb

As soon as our wsgi servers can support 3.6 we should bump the default version used in the cookiecutter to 3.6.

Due to the way Celery 4.0 handles configuration:

http://docs.celeryproject.org/en/latest/userguide/configuration.html#new-lowercase-settings

It seemed better to me to just have a single CELERY variable in our app's config and pass whatever is in that when we setup the Celery app.

However, the disadvantage of that approach is that you can't easily inherit settings from configuration options lower in the stack. Right now, we have to have CELERY defined in lots of places. If we moved to single config variables, then we could have defaults in DefaultProfile and everything else would inherit and override what is needed.

refs #21

see keg_auth.mail and agariadm.libs.mail for example.

Could do this in Keg Auth, but since the app is likely to customize the user, maybe we should do it in the app instead?

Can tie into Keg's db_init_post signal or, as long as DatabaseManager is being customized in app.py can just do:

    def db_init(self):
        super().db_init()
        # If all the developer variables are set, then create our first user.
        try:
            ents.User.add(
                name=self.app.config['DEVELOPER_NAME'],
                email=self.app.config['DEVELOPER_EMAIL'],
                password=self.app.config['DEVELOPER_PASSWORD'],
                is_verified=True,
            )
        except KeyError:
            pass

Is there a smarter way to set this up so that we aren't throwing hard to troubleshoot errors?

More details: https://level12.atlassian.net/wiki/spaces/devs/blog/2018/06/19/802684936/CSRF+protection+SERVER+NAME+variable

https://github.com/level12/board-development/issues/9

Example: https://github.com/level12/racebetter/blob/master/ansible/restart-service.yaml

And add a views.private for private/protected views for the app.

Nick's Keg-Mail integration in ATech: https://github.com/level12/atech-imp/commit/925226b1464c7ce0d9484d4d5001821ef61c9a6f

Better yet, create a "SOP Readme" in Confluence and just link to it.

See https://github.com/level12/agari-adm/pull/75 for everything I needed to do to get Agari provisioned & deployed to beta.

Example from Keg Auth's conftest.py file:

# Because our tests are in keg_auth.testing, which isn't a test module, pytest won't rewrite the
# assertions by default.
pytest.register_assert_rewrite('keg_auth.testing')

We have testing helper libraries, like the GridAssertions class that have asserts. When the asserts fail, we don't get helpful info from py.test unless we do a little custom config per the above.

command python -m venv --version does not exist.

(submitting PR shortly)

I have the sense of this repo also becoming a source of best practices. If that is the case, notifications to #dev may be helpful, just like we do for Ansible roles.

https://github.com/level12/racebetter/pull/621/files#diff-a3843d9a3f939e3fff714e70ef5b8c86R374

Keg work done here: level12/keg#93

But changes to tests were very verbose. I made an attempt on Agari: https://github.com/level12/agari-adm/commit/39e6dcdf801f7fe506d40e2f5dfe5b85880db229

I'm hoping pytest will make some improvements before we have to make this change: pytest-dev/pytest#517 (comment)

Per @guruofgentoo's suggestion, we should use EntityBase from keg.elements instead of ModelBase in tests like these:

Here is an example of it being used.

See Agari for example

• https://github.com/level12/racebetter/commit/0e955bc4dbd2ea55ff31942f1b8e2642312f00a5
• https://github.com/level12/racebetter/commit/d9291c717903d4fcfbba99fd357e42c9306e4945

I had to pin the install of pipenv to 11.10.0 to work around this issue:

pypa/pipenv#2078

It should probably go into KegElements?

https://github.com/pydanny/cookiecutter-django

It's problematic to have the extensions initialized in .app as views can't then import from .app to get things like csrf.

See RB app for an example.

@guruofgentoo updated the Docker image and sudo is no longer available