Create tox config for Bernard repo to validate code style and to execute this check using Jenkins CI tox-docker
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	h.krishna
	Jun 6 2021, 5:00 PM

Description

To check that our code is in working condition and follows the style guidelines every commit, we should create a config for tox so that it works with the existing tox-docker Jenkins jobs.
This would then be executed by jenkins-bot

We could use something else other than tox, but we are sticking to tox so that we conform to the existing DBA codebase (they all use tox)

In future this should be extended for unit tests of the Python code

Tasks

Create tox config for bernard repository to validate styles (flake8?) with jenkins-bot
In future add commands for unit tests check

Acceptance

Able to run tests on Wikimedia Jenkins for style guidelines.
jenkins-bot can be called successfully on the bernard repository

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	bernard: Add basic tox config	operations/software/bernard	master	+107 -27

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	jcrespo	T274636 Develop a web dashboard or a command line tool to help inventory and/or monitor database and backup objects
Resolved	h.krishna	T279552 Develop a web based monitoring dashboard to improve and monitor existing database backup inventory processes and improve long term maintainability of existing code
Resolved	h.krishna	T284404 Create tox config for Bernard repo to validate code style and to execute this check using Jenkins CI tox-docker

Event Timeline

h.krishna created this task.Jun 6 2021, 5:00 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 6 2021, 5:00 PM

h.krishna updated the task description. (Show Details)Jun 6 2021, 5:01 PM

@Marostegui @jcrespo
I wonder if we should stick to using tox for code style validations/unit tests just to maintain consistency with the rest of the DBA codebase? Or is there another better way?

h.krishna added a parent task: T279552: Develop a web based monitoring dashboard to improve and monitor existing database backup inventory processes and improve long term maintainability of existing code.Jun 6 2021, 5:08 PM

h.krishna updated the task description. (Show Details)Jun 6 2021, 11:36 PM

Or is there another better way?

There are other ways, but unless you have a reason, we probably want to stick to that for python code, for easy of use and implementation (the main reason to use python is to uniformize it across same team repos and reduce congnitive load of future maintainers).

If you decide to use something different, make sure you are confident to setup it on our jenkins config repo https://phabricator.wikimedia.org/source/integration-config/browse/master/ , document it thoroughly, and create a potential different docker image.

h.krishna moved this task from Backlog to In Analysis on the dbbackups-dashboard board.Jun 18 2021, 4:42 PM

h.krishna mentioned this in T279552: Develop a web based monitoring dashboard to improve and monitor existing database backup inventory processes and improve long term maintainability of existing code.Jun 23 2021, 11:05 PM

Change 713604 had a related patch set uploaded (by H.krishna123; author: H.krishna123):

[operations/software/bernard@master] [WIP]: Add basic tox config Add Tox config into bernard repository along with the test-requirements.txt so that we can get CI up and running

https://gerrit.wikimedia.org/r/713604

gerritbot added a project: Patch-For-Review.Aug 18 2021, 7:30 AM

Change 713604 merged by Jcrespo:

[operations/software/bernard@master] bernard: Add basic tox config

https://gerrit.wikimedia.org/r/713604

h.krishna mentioned this in rOSBDa6c48c383a09: bernard: Add basic tox config.Aug 24 2021, 10:53 AM

Maintenance_bot removed a project: Patch-For-Review.Aug 24 2021, 11:10 AM

h.krishna closed this task as Resolved.Aug 26 2021, 1:26 PM