class Markdowner(models.Model):
description = MarkdownField(null=True)
unsafe_description = MarkdownField(
null=True,
is_safe=False,
allowed_tags=["p", "object"],
allowed_attrs={"object": ["title", "src"]},
)
name = StringField(null=True, blank=True)
def test_string_field_has_no_max_length_by_default():
field = StringField()
assert field.max_length is None
def test_string_field_is_text_field():
field = StringField()
assert field.deconstruct() == (None, qual_name(StringField), [], {})
assert type(field.formfield()) == CharFormField
class ScratchOrg(SoftDeleteMixin, PushMixin, HashIdMixin, TimestampsMixin,
models.Model):
task = models.ForeignKey(Task, on_delete=models.PROTECT)
org_type = StringField(choices=SCRATCH_ORG_TYPES)
owner = models.ForeignKey(User, on_delete=models.PROTECT)
last_modified_at = models.DateTimeField(null=True, blank=True)
expires_at = models.DateTimeField(null=True, blank=True)
latest_commit = StringField(blank=True)
latest_commit_url = models.URLField(blank=True)
latest_commit_at = models.DateTimeField(null=True, blank=True)
url = models.URLField(blank=True, default="")
last_checked_unsaved_changes_at = models.DateTimeField(null=True,
blank=True)
unsaved_changes = models.JSONField(default=dict,
encoder=DjangoJSONEncoder,
blank=True)
ignored_changes = models.JSONField(default=dict,
encoder=DjangoJSONEncoder,
blank=True)
latest_revision_numbers = models.JSONField(default=dict,
encoder=DjangoJSONEncoder,
blank=True)
currently_refreshing_changes = models.BooleanField(default=False)
currently_capturing_changes = models.BooleanField(default=False)
currently_refreshing_org = models.BooleanField(default=False)
currently_reassigning_user = models.BooleanField(default=False)
is_created = models.BooleanField(default=False)
config = models.JSONField(default=dict,
encoder=DjangoJSONEncoder,
blank=True)
delete_queued_at = models.DateTimeField(null=True, blank=True)
expiry_job_id = StringField(blank=True, default="")
owner_sf_username = StringField(blank=True)
owner_gh_username = StringField(blank=True)
has_been_visited = models.BooleanField(default=False)
valid_target_directories = models.JSONField(default=dict,
encoder=DjangoJSONEncoder,
blank=True)
cci_log = models.TextField(blank=True)
def _build_message_extras(self):
return {
"model": {
"task": str(self.task.id),
"org_type": self.org_type,
"id": str(self.id),
}
}
def subscribable_by(self, user): # pragma: nocover
return True
def save(self, *args, **kwargs):
is_new = self.id is None
self.clean_config()
ret = super().save(*args, **kwargs)
if is_new:
self.queue_provision(originating_user_id=str(self.owner.id))
return ret
def clean_config(self):
banned_keys = {"email", "access_token", "refresh_token"}
self.config = {
k: v
for (k, v) in self.config.items() if k not in banned_keys
}
def mark_visited(self, *, originating_user_id):
self.has_been_visited = True
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def get_refreshed_org_config(self, org_name=None, keychain=None):
org_config = refresh_access_token(
scratch_org=self,
config=self.config,
org_name=org_name or self.task.org_config_name,
keychain=keychain,
)
return org_config
def get_login_url(self):
org_config = self.get_refreshed_org_config()
return org_config.start_url
# begin PushMixin configuration:
push_update_type = "SCRATCH_ORG_UPDATE"
push_error_type = "SCRATCH_ORG_ERROR"
def get_serialized_representation(self, user):
from .serializers import ScratchOrgSerializer
return ScratchOrgSerializer(
self, context=self._create_context_with_user(user)).data
# end PushMixin configuration
def queue_delete(self, *, originating_user_id):
from .jobs import delete_scratch_org_job
# If the scratch org has no `last_modified_at`, it did not
# successfully complete the initial flow run on Salesforce, and
# therefore we don't need to notify of its destruction; this
# should only happen when it is destroyed during the initial
# flow run.
if self.last_modified_at:
self.delete_queued_at = timezone.now()
self.save()
self.notify_changed(originating_user_id=originating_user_id)
delete_scratch_org_job.delay(self,
originating_user_id=originating_user_id)
def finalize_delete(self, *, originating_user_id):
self.notify_changed(
type_="SCRATCH_ORG_DELETE",
originating_user_id=originating_user_id,
message=self._build_message_extras(),
)
def delete(self,
*args,
should_finalize=True,
originating_user_id=None,
**kwargs):
# If the scratch org has no `last_modified_at`, it did not
# successfully complete the initial flow run on Salesforce, and
# therefore we don't need to notify of its destruction; this
# should only happen when it is destroyed during provisioning or
# the initial flow run.
if self.last_modified_at and should_finalize:
self.finalize_delete(originating_user_id=originating_user_id)
super().delete(*args, **kwargs)
def queue_provision(self, *, originating_user_id):
from .jobs import create_branches_on_github_then_create_scratch_org_job
create_branches_on_github_then_create_scratch_org_job.delay(
scratch_org=self, originating_user_id=originating_user_id)
def finalize_provision(self, *, error=None, originating_user_id):
if error is None:
self.save()
self.notify_changed(type_="SCRATCH_ORG_PROVISION",
originating_user_id=originating_user_id)
self.task.finalize_provision(
originating_user_id=originating_user_id)
else:
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_PROVISION_FAILED",
originating_user_id=originating_user_id,
message=self._build_message_extras(),
)
# If the scratch org has already been created on Salesforce,
# we need to delete it there as well.
if self.url:
self.queue_delete(originating_user_id=originating_user_id)
else:
self.delete(originating_user_id=originating_user_id)
def queue_get_unsaved_changes(self,
*,
force_get=False,
originating_user_id):
from .jobs import get_unsaved_changes_job
minutes_since_last_check = (
self.last_checked_unsaved_changes_at is not None
and timezone.now() - self.last_checked_unsaved_changes_at)
should_bail = (not force_get and minutes_since_last_check
and minutes_since_last_check <
timedelta(minutes=settings.ORG_RECHECK_MINUTES))
if should_bail:
return
self.currently_refreshing_changes = True
self.save()
self.notify_changed(originating_user_id=originating_user_id)
get_unsaved_changes_job.delay(self,
originating_user_id=originating_user_id)
def finalize_get_unsaved_changes(self, *, error=None, originating_user_id):
self.currently_refreshing_changes = False
if error is None:
self.last_checked_unsaved_changes_at = timezone.now()
self.save()
self.notify_changed(originating_user_id=originating_user_id)
else:
self.unsaved_changes = {}
self.save()
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_FETCH_CHANGES_FAILED",
originating_user_id=originating_user_id,
)
def queue_commit_changes(
self,
*,
user,
desired_changes,
commit_message,
target_directory,
originating_user_id,
):
from .jobs import commit_changes_from_org_job
self.currently_capturing_changes = True
self.save()
self.notify_changed(originating_user_id=originating_user_id)
commit_changes_from_org_job.delay(
scratch_org=self,
user=user,
desired_changes=desired_changes,
commit_message=commit_message,
target_directory=target_directory,
originating_user_id=originating_user_id,
)
def finalize_commit_changes(self, *, error=None, originating_user_id):
self.currently_capturing_changes = False
self.save()
if error is None:
self.notify_changed(
type_="SCRATCH_ORG_COMMIT_CHANGES",
originating_user_id=originating_user_id,
)
self.task.finalize_commit_changes(
originating_user_id=originating_user_id)
else:
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_COMMIT_CHANGES_FAILED",
originating_user_id=originating_user_id,
)
def remove_scratch_org(self, error, *, originating_user_id):
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_REMOVE",
originating_user_id=originating_user_id,
message=self._build_message_extras(),
)
# set should_finalize=False to avoid accidentally sending a
# SCRATCH_ORG_DELETE event:
self.delete(should_finalize=False,
originating_user_id=originating_user_id)
def queue_refresh_org(self, *, originating_user_id):
from .jobs import refresh_scratch_org_job
self.has_been_visited = False
self.currently_refreshing_org = True
self.save()
self.notify_changed(originating_user_id=originating_user_id)
refresh_scratch_org_job.delay(self,
originating_user_id=originating_user_id)
def finalize_refresh_org(self, *, error=None, originating_user_id):
self.currently_refreshing_org = False
self.save()
if error is None:
self.notify_changed(type_="SCRATCH_ORG_REFRESH",
originating_user_id=originating_user_id)
else:
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_REFRESH_FAILED",
originating_user_id=originating_user_id,
message=self._build_message_extras(),
)
self.queue_delete(originating_user_id=originating_user_id)
def queue_reassign(self, *, new_user, originating_user_id):
from .jobs import user_reassign_job
self.currently_reassigning_user = True
was_deleted = self.deleted_at is not None
self.deleted_at = None
self.save()
if was_deleted:
self.notify_changed(
type_="SCRATCH_ORG_RECREATE",
originating_user_id=originating_user_id,
for_list=True,
)
user_reassign_job.delay(self,
new_user=new_user,
originating_user_id=originating_user_id)
def finalize_reassign(self, *, error=None, originating_user_id):
self.currently_reassigning_user = False
self.save()
if error is None:
self.notify_changed(type_="SCRATCH_ORG_REASSIGN",
originating_user_id=originating_user_id)
else:
self.notify_scratch_org_error(
error=error,
type_="SCRATCH_ORG_REASSIGN_FAILED",
originating_user_id=originating_user_id,
)
self.delete()
class User(HashIdMixin, AbstractUser):
objects = UserManager()
currently_fetching_repos = models.BooleanField(default=False)
devhub_username = StringField(blank=True, default="")
allow_devhub_override = models.BooleanField(default=False)
agreed_to_tos_at = models.DateTimeField(null=True, blank=True)
def notify(self, subject, body):
# Right now, the only way we notify is via email. In future, we
# may add in-app notifications.
# Escape <>& in case the email gets accidentally rendered as HTML
subject = html.escape(subject, quote=False)
body = html.escape(body, quote=False)
send_mail(
subject,
body,
settings.DEFAULT_FROM_EMAIL,
[self.email],
fail_silently=False,
)
def queue_refresh_repositories(self):
"""Queue a job to refresh repositories unless we're already doing so"""
from .jobs import refresh_github_repositories_for_user_job
if not self.currently_fetching_repos:
self.currently_fetching_repos = True
self.save()
refresh_github_repositories_for_user_job.delay(self)
def refresh_repositories(self):
try:
repos = gh.get_all_org_repos(self)
with transaction.atomic():
GitHubRepository.objects.filter(user=self).delete()
GitHubRepository.objects.bulk_create([
GitHubRepository(user=self,
repo_id=repo.id,
repo_url=repo.html_url) for repo in repos
])
finally:
self.refresh_from_db()
self.currently_fetching_repos = False
self.save()
self.notify_repositories_updated()
def notify_repositories_updated(self):
message = {"type": "USER_REPOS_REFRESH"}
async_to_sync(push.push_message_about_instance)(self, message)
def invalidate_salesforce_credentials(self):
self.socialaccount_set.filter(provider="salesforce").delete()
def subscribable_by(self, user):
return self == user
def _get_org_property(self, key):
try:
return self.salesforce_account.extra_data[ORGANIZATION_DETAILS][
key]
except (AttributeError, KeyError, TypeError):
return None
@property
def avatar_url(self):
try:
return self.github_account.get_avatar_url()
except (AttributeError, KeyError, TypeError):
return None
@property
def org_id(self):
try:
return self.salesforce_account.extra_data["organization_id"]
except (AttributeError, KeyError, TypeError):
return None
@property
def org_name(self):
if self.devhub_username or self.uses_global_devhub:
return None
return self._get_org_property("Name")
@property
def org_type(self):
if self.devhub_username or self.uses_global_devhub:
return None
return self._get_org_property("OrganizationType")
@property
def full_org_type(self):
org_type = self._get_org_property("OrganizationType")
is_sandbox = self._get_org_property("IsSandbox")
has_expiration = self._get_org_property(
"TrialExpirationDate") is not None
if org_type is None or is_sandbox is None:
return None
if org_type == "Developer Edition" and not is_sandbox:
return ORG_TYPES.Developer
if org_type != "Developer Edition" and not is_sandbox:
return ORG_TYPES.Production
if is_sandbox and not has_expiration:
return ORG_TYPES.Sandbox
if is_sandbox and has_expiration:
return ORG_TYPES.Scratch
@property
def instance_url(self):
try:
return self.salesforce_account.extra_data["instance_url"]
except (AttributeError, KeyError):
return None
@property
def uses_global_devhub(self):
return bool(settings.DEVHUB_USERNAME and not self.devhub_username
and not self.allow_devhub_override)
@property
def sf_username(self):
if self.devhub_username:
return self.devhub_username
if self.uses_global_devhub:
return settings.DEVHUB_USERNAME
try:
return self.salesforce_account.extra_data["preferred_username"]
except (AttributeError, KeyError):
return None
@property
def sf_token(self):
try:
token = self.salesforce_account.socialtoken_set.first()
return (
fernet_decrypt(token.token) if token.token else None,
token.token_secret if token.token_secret else None,
)
except (InvalidToken, AttributeError):
return (None, None)
@property
def gh_token(self):
return self.socialaccount_set.get(
provider="github").socialtoken_set.get().token
@property
def github_account(self):
return self.socialaccount_set.filter(provider="github").first()
@property
def salesforce_account(self):
return self.socialaccount_set.filter(provider="salesforce").first()
@property
def valid_token_for(self):
if self.devhub_username or self.uses_global_devhub:
return None
if all(self.sf_token) and self.org_id:
return self.org_id
return None
@cached_property
def is_devhub_enabled(self):
# We can shortcut and avoid making an HTTP request in some cases:
if self.devhub_username or self.uses_global_devhub:
return True
if not self.salesforce_account:
return False
if self.full_org_type in (ORG_TYPES.Scratch, ORG_TYPES.Sandbox):
return False
try:
client = get_devhub_api(devhub_username=self.sf_username)
resp = client.restful("sobjects/ScratchOrgInfo")
if resp:
return True
return False
except (SalesforceError, HTTPError):
return False
class Task(
CreatePrMixin,
PushMixin,
HashIdMixin,
TimestampsMixin,
SlugMixin,
SoftDeleteMixin,
models.Model,
):
name = StringField()
epic = models.ForeignKey(Epic,
on_delete=models.PROTECT,
related_name="tasks")
description = MarkdownField(blank=True, property_suffix="_markdown")
branch_name = models.CharField(max_length=100,
blank=True,
default="",
validators=[validate_unicode_branch])
org_config_name = StringField()
commits = models.JSONField(default=list, blank=True)
origin_sha = StringField(blank=True, default="")
metecho_commits = models.JSONField(default=list, blank=True)
has_unmerged_commits = models.BooleanField(default=False)
currently_creating_pr = models.BooleanField(default=False)
pr_number = models.IntegerField(null=True, blank=True)
pr_is_open = models.BooleanField(default=False)
currently_submitting_review = models.BooleanField(default=False)
review_submitted_at = models.DateTimeField(null=True, blank=True)
review_valid = models.BooleanField(default=False)
review_status = models.CharField(choices=TASK_REVIEW_STATUS,
blank=True,
default="",
max_length=32)
review_sha = StringField(blank=True, default="")
reviewers = models.JSONField(default=list, blank=True)
status = models.CharField(choices=TASK_STATUSES,
default=TASK_STATUSES.Planned,
max_length=16)
# Assignee user data is shaped like this:
# {
# "id": str,
# "login": str,
# "avatar_url": str,
# }
assigned_dev = models.JSONField(null=True, blank=True)
assigned_qa = models.JSONField(null=True, blank=True)
slug_class = TaskSlug
tracker = FieldTracker(fields=["name"])
def __str__(self):
return self.name
def save(self, *args, force_epic_save=False, **kwargs):
ret = super().save(*args, **kwargs)
# To update the epic's status:
if force_epic_save or self.epic.should_update_status():
self.epic.save()
self.epic.notify_changed(originating_user_id=None)
return ret
def subscribable_by(self, user): # pragma: nocover
return True
# begin SoftDeleteMixin configuration:
def soft_delete_child_class(self):
return ScratchOrg
# end SoftDeleteMixin configuration
# begin PushMixin configuration:
push_update_type = "TASK_UPDATE"
push_error_type = "TASK_CREATE_PR_FAILED"
def get_serialized_representation(self, user):
from .serializers import TaskSerializer
return TaskSerializer(
self, context=self._create_context_with_user(user)).data
# end PushMixin configuration
# begin CreatePrMixin configuration:
create_pr_event = "TASK_CREATE_PR"
@property
def get_all_users_in_commits(self):
ret = []
for commit in self.commits:
if commit["author"] not in ret:
ret.append(commit["author"])
ret.sort(key=lambda d: d["username"])
return ret
def add_reviewer(self, user):
if user not in self.reviewers:
self.reviewers.append(user)
self.save()
def get_repo_id(self):
return self.epic.project.get_repo_id()
def get_base(self):
return self.epic.branch_name
def get_head(self):
return self.branch_name
def try_to_notify_assigned_user(self):
# This takes the tester (a.k.a. assigned_qa) and sends them an
# email when a PR has been made.
assigned = self.assigned_qa
id_ = assigned.get("id") if assigned else None
sa = SocialAccount.objects.filter(provider="github", uid=id_).first()
user = getattr(sa, "user", None)
if user:
task = self
epic = task.epic
project = epic.project
metecho_link = get_user_facing_url(
path=["projects", project.slug, epic.slug, task.slug])
subject = _("Metecho Task Submitted for Testing")
body = render_to_string(
"pr_created_for_task.txt",
{
"task_name": task.name,
"epic_name": epic.name,
"project_name": project.name,
"assigned_user_name": user.username,
"metecho_link": metecho_link,
},
)
user.notify(subject, body)
# end CreatePrMixin configuration
def update_review_valid(self):
review_valid = bool(self.review_sha and self.commits
and self.review_sha == self.commits[0].get("id"))
self.review_valid = review_valid
def update_has_unmerged_commits(self):
base = self.get_base()
head = self.get_head()
if head and base:
repo = gh.get_repo_info(
None,
repo_owner=self.epic.project.repo_owner,
repo_name=self.epic.project.repo_name,
)
base_sha = repo.branch(base).commit.sha
head_sha = repo.branch(head).commit.sha
self.has_unmerged_commits = (repo.compare_commits(
base_sha, head_sha).ahead_by > 0)
def finalize_task_update(self, *, originating_user_id):
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_status_completed(self, pr_number, *, originating_user_id):
self.status = TASK_STATUSES.Completed
self.has_unmerged_commits = False
self.pr_number = pr_number
self.pr_is_open = False
self.epic.has_unmerged_commits = True
# This will save the epic, too:
self.save(force_epic_save=True)
self.notify_changed(originating_user_id=originating_user_id)
def finalize_pr_closed(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_pr_opened(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = True
self.pr_is_merged = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_provision(self, *, originating_user_id):
if self.status == TASK_STATUSES.Planned:
self.status = TASK_STATUSES["In progress"]
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_commit_changes(self, *, originating_user_id):
if self.status != TASK_STATUSES["In progress"]:
self.status = TASK_STATUSES["In progress"]
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def add_commits(self, commits, sender):
self.commits = [
gh.normalize_commit(c, sender=sender) for c in commits
] + self.commits
self.update_has_unmerged_commits()
self.update_review_valid()
self.save()
# This comes from the GitHub hook, and so has no originating user:
self.notify_changed(originating_user_id=None)
def add_metecho_git_sha(self, sha):
self.metecho_commits.append(sha)
def queue_submit_review(self, *, user, data, originating_user_id):
from .jobs import submit_review_job
self.currently_submitting_review = True
self.save()
self.notify_changed(originating_user_id=originating_user_id)
submit_review_job.delay(user=user,
task=self,
data=data,
originating_user_id=originating_user_id)
def finalize_submit_review(
self,
timestamp,
*,
error=None,
sha=None,
status="",
delete_org=False,
org=None,
originating_user_id,
):
self.currently_submitting_review = False
if error:
self.save()
self.notify_error(
error,
type_="TASK_SUBMIT_REVIEW_FAILED",
originating_user_id=originating_user_id,
)
else:
self.review_submitted_at = timestamp
self.review_status = status
self.review_sha = sha
self.update_review_valid()
self.save()
self.notify_changed(type_="TASK_SUBMIT_REVIEW",
originating_user_id=originating_user_id)
deletable_org = (org and org.task == self
and org.org_type == SCRATCH_ORG_TYPES.QA)
if delete_org and deletable_org:
org.queue_delete(originating_user_id=originating_user_id)
class Meta:
ordering = ("-created_at", "name")
class Epic(
CreatePrMixin,
PushMixin,
HashIdMixin,
TimestampsMixin,
SlugMixin,
SoftDeleteMixin,
models.Model,
):
name = StringField()
description = MarkdownField(blank=True, property_suffix="_markdown")
branch_name = models.CharField(max_length=100,
blank=True,
default="",
validators=[validate_unicode_branch])
has_unmerged_commits = models.BooleanField(default=False)
currently_creating_pr = models.BooleanField(default=False)
pr_number = models.IntegerField(null=True, blank=True)
pr_is_open = models.BooleanField(default=False)
pr_is_merged = models.BooleanField(default=False)
status = models.CharField(max_length=20,
choices=EPIC_STATUSES,
default=EPIC_STATUSES.Planned)
# List of {
# "key": str,
# "label": str,
# "description": str,
# }
available_task_org_config_names = models.JSONField(default=list,
blank=True)
currently_fetching_org_config_names = models.BooleanField(default=False)
project = models.ForeignKey(Project,
on_delete=models.PROTECT,
related_name="epics")
# User data is shaped like this:
# {
# "id": str,
# "login": str,
# "avatar_url": str,
# }
github_users = models.JSONField(default=list, blank=True)
slug_class = EpicSlug
tracker = FieldTracker(fields=["name"])
def __str__(self):
return self.name
def save(self, *args, **kwargs):
self.update_status()
return super().save(*args, **kwargs)
def subscribable_by(self, user): # pragma: nocover
return True
# begin SoftDeleteMixin configuration:
def soft_delete_child_class(self):
return Task
# end SoftDeleteMixin configuration
# begin PushMixin configuration:
push_update_type = "EPIC_UPDATE"
push_error_type = "EPIC_CREATE_PR_FAILED"
def get_serialized_representation(self, user):
from .serializers import EpicSerializer
return EpicSerializer(
self, context=self._create_context_with_user(user)).data
# end PushMixin configuration
# begin CreatePrMixin configuration:
create_pr_event = "EPIC_CREATE_PR"
def get_repo_id(self):
return self.project.get_repo_id()
def get_base(self):
return self.project.branch_name
def get_head(self):
return self.branch_name
def try_to_notify_assigned_user(self): # pragma: nocover
# Does nothing in this case.
pass
# end CreatePrMixin configuration
def create_gh_branch(self, user):
from .jobs import create_gh_branch_for_new_epic_job
create_gh_branch_for_new_epic_job.delay(self, user=user)
def should_update_in_progress(self):
task_statuses = self.tasks.values_list("status", flat=True)
return task_statuses and any(status != TASK_STATUSES.Planned
for status in task_statuses)
def should_update_review(self):
task_statuses = self.tasks.values_list("status", flat=True)
return task_statuses and all(status == TASK_STATUSES.Completed
for status in task_statuses)
def should_update_merged(self):
return self.pr_is_merged
def should_update_status(self):
if self.should_update_merged():
return self.status != EPIC_STATUSES.Merged
elif self.should_update_review():
return self.status != EPIC_STATUSES.Review
elif self.should_update_in_progress():
return self.status != EPIC_STATUSES["In progress"]
return False
def update_status(self):
if self.should_update_merged():
self.status = EPIC_STATUSES.Merged
elif self.should_update_review():
self.status = EPIC_STATUSES.Review
elif self.should_update_in_progress():
self.status = EPIC_STATUSES["In progress"]
def finalize_pr_closed(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_pr_opened(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = True
self.pr_is_merged = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_epic_update(self, *, originating_user_id):
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_status_completed(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_merged = True
self.has_unmerged_commits = False
self.pr_is_open = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def queue_available_task_org_config_names(self, user):
from .jobs import available_task_org_config_names_job
self.currently_fetching_org_config_names = True
self.save()
self.notify_changed(originating_user_id=str(user.id))
available_task_org_config_names_job.delay(self, user=user)
def finalize_available_task_org_config_names(self,
originating_user_id=None):
self.currently_fetching_org_config_names = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
class Meta:
ordering = ("-created_at", "name")
class Project(
PushMixin,
PopulateRepoIdMixin,
HashIdMixin,
TimestampsMixin,
SlugMixin,
models.Model,
):
repo_owner = StringField()
repo_name = StringField()
name = StringField(unique=True)
description = MarkdownField(blank=True, property_suffix="_markdown")
is_managed = models.BooleanField(default=False)
repo_id = models.IntegerField(null=True, blank=True, unique=True)
repo_image_url = models.URLField(blank=True)
include_repo_image_url = models.BooleanField(default=True)
branch_name = models.CharField(
max_length=100,
blank=True,
validators=[validate_unicode_branch],
default="master",
)
branch_prefix = StringField(blank=True)
# User data is shaped like this:
# {
# "id": str,
# "login": str,
# "avatar_url": str,
# }
github_users = models.JSONField(default=list, blank=True)
slug_class = ProjectSlug
tracker = FieldTracker(fields=["name"])
def subscribable_by(self, user): # pragma: nocover
return True
# begin PushMixin configuration:
push_update_type = "PROJECT_UPDATE"
push_error_type = "PROJECT_UPDATE_ERROR"
def get_serialized_representation(self, user):
from .serializers import ProjectSerializer
return ProjectSerializer(
self, context=self._create_context_with_user(user)).data
# end PushMixin configuration
def __str__(self):
return self.name
class Meta:
ordering = ("name", )
unique_together = (("repo_owner", "repo_name"), )
def save(self, *args, **kwargs):
if not self.branch_name:
repo = gh.get_repo_info(None,
repo_owner=self.repo_owner,
repo_name=self.repo_name)
self.branch_name = repo.default_branch
if not self.github_users:
self.queue_populate_github_users(originating_user_id=None)
if not self.repo_image_url:
from .jobs import get_social_image_job
get_social_image_job.delay(project=self)
super().save(*args, **kwargs)
def finalize_get_social_image(self):
self.save()
self.notify_changed(originating_user_id=None)
def queue_populate_github_users(self, *, originating_user_id):
from .jobs import populate_github_users_job
populate_github_users_job.delay(
self, originating_user_id=originating_user_id)
def finalize_populate_github_users(self,
*,
error=None,
originating_user_id):
if error is None:
self.save()
self.notify_changed(originating_user_id=originating_user_id)
else:
self.notify_error(error, originating_user_id=originating_user_id)
def queue_refresh_commits(self, *, ref, originating_user_id):
from .jobs import refresh_commits_job
refresh_commits_job.delay(project=self,
branch_name=ref,
originating_user_id=originating_user_id)
@transaction.atomic
def add_commits(self, *, commits, ref, sender):
matching_tasks = Task.objects.filter(branch_name=ref,
epic__project=self)
for task in matching_tasks:
task.add_commits(commits, sender)
class Epic(
CreatePrMixin,
PushMixin,
HashIdMixin,
TimestampsMixin,
SlugMixin,
SoftDeleteMixin,
models.Model,
):
name = StringField()
description = MarkdownField(blank=True, property_suffix="_markdown")
branch_name = models.CharField(
max_length=100, blank=True, default="", validators=[validate_unicode_branch]
)
has_unmerged_commits = models.BooleanField(default=False)
currently_creating_branch = models.BooleanField(default=False)
currently_creating_pr = models.BooleanField(default=False)
pr_number = models.IntegerField(null=True, blank=True)
pr_is_open = models.BooleanField(default=False)
pr_is_merged = models.BooleanField(default=False)
status = models.CharField(
max_length=20, choices=EPIC_STATUSES, default=EPIC_STATUSES.Planned
)
latest_sha = StringField(blank=True)
project = models.ForeignKey(Project, on_delete=models.PROTECT, related_name="epics")
github_users = models.JSONField(default=list, blank=True)
slug_class = EpicSlug
tracker = FieldTracker(fields=["name"])
def __str__(self):
return self.name
def save(self, *args, **kwargs):
self.update_status()
return super().save(*args, **kwargs)
def subscribable_by(self, user): # pragma: nocover
return True
def get_absolute_url(self):
# See src/js/utils/routes.ts
return f"/projects/{self.project.slug}/{self.slug}"
# begin SoftDeleteMixin configuration:
def soft_delete_child_class(self):
return Task
# end SoftDeleteMixin configuration
# begin PushMixin configuration:
push_update_type = "EPIC_UPDATE"
push_error_type = "EPIC_CREATE_PR_FAILED"
def get_serialized_representation(self, user):
from .serializers import EpicSerializer
return EpicSerializer(self, context=self._create_context_with_user(user)).data
# end PushMixin configuration
# begin CreatePrMixin configuration:
create_pr_event = "EPIC_CREATE_PR"
def get_repo_id(self):
return self.project.get_repo_id()
def get_base(self):
return self.project.branch_name
def get_head(self):
return self.branch_name
def try_to_notify_assigned_user(self): # pragma: nocover
# Does nothing in this case.
pass
# end CreatePrMixin configuration
def has_push_permission(self, user):
return self.project.has_push_permission(user)
def create_gh_branch(self, user):
from .jobs import create_gh_branch_for_new_epic_job
create_gh_branch_for_new_epic_job.delay(self, user=user)
def should_update_in_progress(self):
task_statuses = self.tasks.values_list("status", flat=True)
return task_statuses and any(
status != TASK_STATUSES.Planned for status in task_statuses
)
def should_update_review(self):
"""
Returns truthy if:
- there is at least one completed task
- all tasks are completed or canceled
"""
task_statuses = self.tasks.values_list("status", flat=True)
return (
task_statuses
and all(
status in [TASK_STATUSES.Completed, TASK_STATUSES.Canceled]
for status in task_statuses
)
and any(status == TASK_STATUSES.Completed for status in task_statuses)
)
def should_update_merged(self):
return self.pr_is_merged
def should_update_status(self):
if self.should_update_merged():
return self.status != EPIC_STATUSES.Merged
elif self.should_update_review():
return self.status != EPIC_STATUSES.Review
elif self.should_update_in_progress():
return self.status != EPIC_STATUSES["In progress"]
return False
def update_status(self):
if self.should_update_merged():
self.status = EPIC_STATUSES.Merged
elif self.should_update_review():
self.status = EPIC_STATUSES.Review
elif self.should_update_in_progress():
self.status = EPIC_STATUSES["In progress"]
def finalize_pr_closed(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_pr_opened(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_open = True
self.pr_is_merged = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_epic_update(self, *, originating_user_id=None):
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_status_completed(self, pr_number, *, originating_user_id):
self.pr_number = pr_number
self.pr_is_merged = True
self.has_unmerged_commits = False
self.pr_is_open = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def add_commits(self, commits):
self.latest_sha = commits[0].get("id") if commits else ""
self.finalize_epic_update()
class Meta:
ordering = ("-created_at", "name")
class Project(
PushMixin,
PopulateRepoIdMixin,
HashIdMixin,
TimestampsMixin,
SlugMixin,
models.Model,
):
repo_owner = StringField()
repo_name = StringField()
name = StringField(unique=True)
description = MarkdownField(blank=True, property_suffix="_markdown")
is_managed = models.BooleanField(default=False)
repo_id = models.IntegerField(null=True, blank=True, unique=True)
repo_image_url = models.URLField(blank=True)
include_repo_image_url = models.BooleanField(default=True)
branch_name = models.CharField(
max_length=100,
blank=True,
validators=[validate_unicode_branch],
)
branch_prefix = StringField(blank=True)
# User data is shaped like this:
# {
# "id": str,
# "login": str,
# "name": str,
# "avatar_url": str,
# "permissions": {
# "push": bool,
# "pull": bool,
# "admin": bool,
# },
# }
github_users = models.JSONField(default=list, blank=True)
# List of {
# "key": str,
# "label": str,
# "description": str,
# }
org_config_names = models.JSONField(default=list, blank=True)
currently_fetching_org_config_names = models.BooleanField(default=False)
currently_fetching_github_users = models.BooleanField(default=False)
latest_sha = StringField(blank=True)
slug_class = ProjectSlug
tracker = FieldTracker(fields=["name"])
def subscribable_by(self, user): # pragma: nocover
return True
def get_absolute_url(self):
# See src/js/utils/routes.ts
return f"/projects/{self.slug}"
# begin PushMixin configuration:
push_update_type = "PROJECT_UPDATE"
push_error_type = "PROJECT_UPDATE_ERROR"
def get_serialized_representation(self, user):
from .serializers import ProjectSerializer
return ProjectSerializer(
self, context=self._create_context_with_user(user)
).data
# end PushMixin configuration
def __str__(self):
return self.name
class Meta:
ordering = ("name",)
unique_together = (("repo_owner", "repo_name"),)
def save(self, *args, **kwargs):
if not self.branch_name:
repo = gh.get_repo_info(
None, repo_owner=self.repo_owner, repo_name=self.repo_name
)
self.branch_name = repo.default_branch
self.latest_sha = repo.branch(repo.default_branch).latest_sha()
if not self.latest_sha:
repo = gh.get_repo_info(
None, repo_owner=self.repo_owner, repo_name=self.repo_name
)
self.latest_sha = repo.branch(self.branch_name).latest_sha()
super().save(*args, **kwargs)
def finalize_get_social_image(self):
self.save()
self.notify_changed(originating_user_id=None)
def queue_refresh_github_users(self, *, originating_user_id):
from .jobs import refresh_github_users_job
if not self.currently_fetching_github_users:
self.currently_fetching_github_users = True
self.save()
refresh_github_users_job.delay(
self, originating_user_id=originating_user_id
)
def finalize_refresh_github_users(self, *, error=None, originating_user_id):
self.currently_fetching_github_users = False
self.save()
if error is None:
self.notify_changed(originating_user_id=originating_user_id)
else:
self.notify_error(error, originating_user_id=originating_user_id)
def queue_refresh_commits(self, *, ref, originating_user_id):
from .jobs import refresh_commits_job
refresh_commits_job.delay(
project=self, branch_name=ref, originating_user_id=originating_user_id
)
def queue_available_org_config_names(self, user=None):
from .jobs import available_org_config_names_job
self.currently_fetching_org_config_names = True
self.save()
self.notify_changed(originating_user_id=str(user.id) if user else None)
available_org_config_names_job.delay(self, user=user)
def finalize_available_org_config_names(self, originating_user_id=None):
self.currently_fetching_org_config_names = False
self.save()
self.notify_changed(originating_user_id=originating_user_id)
def finalize_project_update(self, *, originating_user_id=None):
self.save()
self.notify_changed(originating_user_id=originating_user_id)
@transaction.atomic
def add_commits(self, *, commits, ref, sender):
if self.branch_name == ref:
self.latest_sha = commits[0].get("id") if commits else ""
self.finalize_project_update()
matching_epics = Epic.objects.filter(branch_name=ref, project=self)
for epic in matching_epics:
epic.add_commits(commits)
matching_tasks = Task.objects.filter(branch_name=ref, epic__project=self)
for task in matching_tasks:
task.add_commits(commits, sender)
def has_push_permission(self, user):
return GitHubRepository.objects.filter(
user=user,
repo_id=self.repo_id,
permissions__push=True,
).exists()
def get_collaborator(self, gh_uid: str) -> Optional[Dict[str, object]]:
try:
return [u for u in self.github_users if u["id"] == gh_uid][0]
except IndexError:
return None