-
Notifications
You must be signed in to change notification settings - Fork 965
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dev): add command to generate some observations (#15664)
- Loading branch information
1 parent
dad35b8
commit 585e064
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
import random | ||
|
||
import click | ||
|
||
from warehouse.cli import warehouse | ||
|
||
|
||
@warehouse.group() | ||
def observations(): | ||
""" | ||
Group for observation commands. | ||
""" | ||
|
||
|
||
@observations.command() | ||
@click.pass_obj | ||
def generate_random_observations(config): # pragma: no cover # dev-only tool | ||
""" | ||
Generate random Observations, DEVELOPMENT ONLY | ||
Generates random observations for 10 projects in the database, | ||
along with any associated Observer models. | ||
It is only available in development mode, useful for | ||
""" | ||
# Imported here because we don't want to trigger an import from anything | ||
# but warehouse.cli at the module scope. | ||
from sqlalchemy import select | ||
|
||
from warehouse.accounts.models import User | ||
from warehouse.config import Environment | ||
from warehouse.db import Session | ||
from warehouse.observations.models import ObservationKind | ||
from warehouse.packaging.models import Project | ||
|
||
# bail early if not in development | ||
if not config.registry.settings.get("warehouse.env") == Environment.development: | ||
raise click.ClickException( | ||
"This command is only available in development mode." | ||
) | ||
|
||
session = Session(bind=config.registry["sqlalchemy.engine"]) | ||
|
||
# A `request`-like object that implements the `db` method | ||
class MockRequest: | ||
def __init__(self): | ||
self.db = session | ||
|
||
request = MockRequest() | ||
|
||
# Get 10 users and project | ||
users = session.scalars(select(User).limit(10)).unique().all() | ||
projects = session.scalars(select(Project).limit(10)).all() | ||
|
||
# generate 10 random observations for each project | ||
for project in projects: | ||
[ | ||
project.record_observation( | ||
request=request, | ||
kind=random.choice(list(ObservationKind)), | ||
actor=random.choice(users), | ||
summary="CLI Generated", | ||
payload={"origin": "CLI"}, | ||
) | ||
for _ in range(10) | ||
] | ||
session.commit() # Finally, commit the transaction | ||
|
||
click.echo("Generated random observations for 10 projects.") |