Move most modules to package at root level, rename from "src" to "jbi" (#176)

* Move most files to root project folder, rename too to "jbi"

Before, we had this project structure
```
src
├── __init__.py
├── app
├── jbi
├── static
├── templates
```

the differences between `src/app` and `src/jbi` weren't clear enough
to warrant separate packages, so in this commit we move most modules
into the root package, renamed to `jbi/`. We also change the structure
of the test files accordingly and update any other files that referred
to src/*.

* Rename "whiteboard_actions" package to "actions"

Author: grahamalama

.dockerignore

@@ -4,7 +4,7 @@
 !/asgi.py
 !/bin
 !/config
+!/jbi
 !/poetry.lock
 !/pyproject.toml
-!/src
 !/version.json

.yamllint

@@ -3,7 +3,7 @@
 extends: default
 
 ignore: |
-  src/
+  jbi/
   tests/
   bin/
   .github/

README.md

@@ -22,7 +22,7 @@ Below is a full example of an action configuration:
   contact: [email protected]
   description: example configuration
   enabled: true
-  module: src.jbi.whiteboard_actions.default
+  module: jbi.actions.default
   parameters:
     jira_project_key: EXMPL
 ```
@@ -50,7 +50,7 @@ A bit more about the different fields...
     - If false, matching events will not be synchronized
 - `module` (optional)
     - string
-    - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
+    - default: [jbi.actions.default](jbi/actions/default.py)
     - The specified Python module must be available in the `PYTHONPATH`
 - `parameters` (optional)
     - dict
@@ -66,7 +66,7 @@ A bit more about the different fields...
 ## Available Actions
 
 ### Default
-The `src.jbi.whiteboard_actions.default` action will create or update the Jira issue and its comments.
+The `jbi.actions.default` action will create or update the Jira issue and its comments.
 It will also set the Jira issue URL in the Bugzilla bug `see_also` field.
 
 **Parameters**
@@ -80,13 +80,13 @@ Example configuration:
     whiteboard_tag: example
     contact: [email protected]
     description: example configuration
-    module: src.jbi.whiteboard_actions.default
+    module: jbi.actions.default
     parameters:
       jira_project_key: EXMPL
 ```
 
 ### Default with assignee and status action
-The `src.jbi.whiteboard_actions.default_with_assignee_and_status` action adds some additional
+The `jbi.actions.default_with_assignee_and_status` action adds some additional
 features on top of the default.
 
 It will attempt to assign the Jira issue the same person as the bug is assigned to. This relies on
@@ -111,7 +111,7 @@ Example configuration:
     contact: [email protected]
     description: example configuration
     enabled: true
-    module: src.jbi.whiteboard_actions.default_with_assignee_and_status
+    module: jbi.actions.default_with_assignee_and_status
     parameters:
       jira_project_key: EXMPL
       status_map:
@@ -125,7 +125,7 @@ linked Jira issue status to "Closed". If the bug changes to a status not listed
 no change will be made to the Jira issue.
 
 ### Custom Actions
-If you're looking for a unique capability for your team's data flow, you can add your own Python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)
+If you're looking for a unique capability for your team's data flow, you can add your own Python methods and functionality[...read more here.](jbi/actions/README.md)
 
 
 ## Diagram Overview
@@ -210,7 +210,7 @@ GET /whiteboard_tags/
         "contact": "[email protected]",
         "description": "Addons whiteboard tag for AMO Team",
         "enabled": true,
-        "module": "src.jbi.whiteboard_actions.default",
+        "module": "jbi.actions.default",
         "parameters": {
             "jira_project_key": "WEBEXT"
         }

asgi.py

@@ -1,15 +1,15 @@
 import uvicorn
 
-from src.app.environment import get_settings
-from src.app.log import CONFIG as LOGGING_CONFIG
+from jbi.environment import get_settings
+from jbi.log import CONFIG as LOGGING_CONFIG
 
 settings = get_settings()
 
 
 if __name__ == "__main__":
     server = uvicorn.Server(
         uvicorn.Config(
-            "src.app.main:app",
+            "jbi.app:app",
             host=settings.host,
             port=settings.port,
             reload=settings.app_reload,

bin/lint.sh

@@ -5,10 +5,10 @@ set -e
 POETRY_RUN="poetry run"
 
 bandit () {
-  $POETRY_RUN bandit -lll --recursive src
+  $POETRY_RUN bandit -lll --recursive jbi
 }
 black () {
-  $POETRY_RUN black ${check:+--check} src tests
+  $POETRY_RUN black ${check:+--check} jbi tests
 }
 detect_secrets () {
   # Scan only files fixed into the repo, omit poetry.lock
@@ -19,10 +19,10 @@ isort () {
   $POETRY_RUN isort ${check:+--check-only} .
 }
 pylint () {
-  $POETRY_RUN pylint src tests
+  $POETRY_RUN pylint jbi tests
 }
 mypy () {
-  $POETRY_RUN mypy src
+  $POETRY_RUN mypy jbi
 }
 yamllint () {
   $POETRY_RUN yamllint -c .yamllint config/*.yaml

config/config.nonprod.yaml

@@ -12,7 +12,7 @@
   contact: [email protected]
   description: Flowstate whiteboard tag
   enabled: true
-  module: src.jbi.whiteboard_actions.default_with_assignee_and_status
+  module: jbi.actions.default_with_assignee_and_status
   parameters:
     jira_project_key: MR2
     status_map:

config/config.prod.yaml

@@ -4,7 +4,7 @@
   contact: tbd
   description: Addons whiteboard tag for AMO Team
   enabled: true
-  # module: src.jbi.whiteboard_actions.default
+  # module: jbi.actions.default
   parameters:
     jira_project_key: WEBEXT
 
@@ -19,7 +19,7 @@
   contact: [email protected]
   description: Firefox Front End whiteboard tag
   enabled: true
-  module: src.jbi.whiteboard_actions.default_with_assignee_and_status
+  module: jbi.actions.default_with_assignee_and_status
   parameters:
     jira_project_key: FIDEFE
     status_map:
@@ -32,7 +32,7 @@
   contact: [email protected]
   description: Flowstate whiteboard tag
   enabled: true
-  module: src.jbi.whiteboard_actions.default_with_assignee_and_status
+  module: jbi.actions.default_with_assignee_and_status
   parameters:
     jira_project_key: MR2
     status_map:

src/jbi/__init__.py renamed to jbi/__init__.py

@@ -0,0 +1,33 @@
+## Looking to add a new action?
+
+"actions" are Python modules that, if available in the `PYTHONPATH`,
+can be run by updating the `module` attribute of the YAML config file.
+
+### Create a new action...
+
+Let's create a `new_action`!
+
+1. First, add a new Python file (eg. `my_team_action.py`) in the `jbi/actions/` directory.
+1. Add the Python function `init` to the module, for example:
+
+   ```python
+   from jbi import ActionResult, Operation
+
+   def init(jira_project_key, optional_param=42):
+
+       def execute(payload) -> ActionResult:
+           print(f"{optional_param}, going to {jira_project_key}!")
+           return True, {"result": 42}
+
+       return execute
+   ```
+
+   1. In the above example the `jira_project_key` parameter is required
+   1. `optional_param`, which has a default value, is not required to run this action
+   1. `init()` returns a `__call__`able object that the system calls with the Bugzilla request payload
+   1. The returned `ActionResult` features a boolean to indicate whether something was performed or not, along with a `Dict` (used as a response to the WebHook endpoint).
+
+1. Use the `payload` to perform the desired processing!
+1. Use the available service calls from `jbi/services.py` (or make new ones)
+1. Update the `README.md` to document your action
+1. Now the action `jbi.actions.my_team_actions` can be used in the YAML configuration, under the `module` key.