Add Forgejo Issues support

[mynk8]

TODO:

• Write new tests or update the old ones to cover new functionality.
• Update or write new documentation in packit/packit.dev.

Fixes #880

RELEASE NOTES BEGIN

ogr now supports Forgejo Issues

• comment
• assign labels
• set title
• close issue
• get issues

RELEASE NOTES END

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/051feb15fdf2456cab9ce9446fc00a87

❌ pre-commit FAILURE in 2m 49s
✔️ ogr-tests-pip-deps SUCCESS in 17m 23s

[mfocko]

IIUC the docs are inherited from the abstract classes, so we're left with just the pagination and tests

[mfocko]

I'm not really sure if this produces what you think it does… looking at the definition of IssueStatus, it is an IntEnum, I think you'll find out when you start testing it.

[mfocko]

This part here is a bit tricky… See packit/packit#2543 (comment) and related notes…

1. You don't get a full list, cause it is paginated
2. Once you start fetching everything page-by-page, don't construct a list, implement this as an iterator (I'll be committing similar code for ForgejoProject today, so you should be able to see basic outline of how it looks like)

[mynk8]

Totally missed it, will do the changes

[mfocko]

Same here with the pagination

[mynk8]

So, I wrote all the tests for Forgejo Issues from the Gitlab ones. What's left is to handle pagination, regex tests are not being tested without a pattern for now, will fix later and add docstrings.

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/8bd247cded9b4578aa5574a4c0422c3f

❌ pre-commit FAILURE in 2m 45s
❌ ogr-tests-pip-deps FAILURE in 2m 06s

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/b17e0519327d4c1298fc4d23c56031a0

❌ pre-commit FAILURE in 2m 49s
❌ ogr-tests-pip-deps FAILURE in 1m 53s

[mynk8]

my bad cleaning this up, rebasing

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/e1d52a74084f4f2a8a27e319846a6f86

❌ pre-commit FAILURE in 3m 47s
❌ ogr-tests-pip-deps FAILURE in 2m 00s

[softwarefactory-project-zuul]

Merge Failed.

This change or one of its cross-repo dependencies was unable to be automatically merged with the current state of its repository. Please rebase the change and upload a new patchset.
Warning:
Error merging github.com/packit/ogr for 896,f469d7365a0e6b4e689eda509399cfe7b0333ccf

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/d059c326ee464714a0a66b2b428adc0e

❌ pre-commit FAILURE in 3m 57s
❌ ogr-tests-pip-deps FAILURE in 2m 09s

[softwarefactory-project-zuul]

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/e50b5d15d5eb41258d0843a49aa84823

❌ pre-commit FAILURE in 3m 45s
❌ ogr-tests-pip-deps FAILURE in 1m 56s

[mfocko]

Hi, I've pulled in some changes from #893, could you please rebase and see what happens (with the CI)? :)

Also, I've added some utility functions related to the workaround for repeated owner, repo in the API, it would be ideal, if you switched to that from your own “hack”:

• pagination (note: we have agreed on returning iterables instead of the whole lists, you have implemented it with the lists so far, could you please switch to the iterables? you can also see some of the changes it required in the commits, if you need help, feel free to reach out)
  • function itself
    

    ogr/ogr/services/forgejo/utils.py

    Lines 7 to 14 in 9c5d2d5

    	def paginate(api_call, /, *args, **kwargs):
    	api_call = partial(api_call, *args, **kwargs)
    	page = 1
    	while objects := api_call(page=page):
    	yield from objects
    	page += 1

  • usage
    

    ogr/ogr/services/forgejo/project.py

    Lines 361 to 368 in 9c5d2d5

    	def get_tags(self) -> Iterable["GitTag"]:
    	return (
    	GitTag(
    	name=tag.name,
    	commit_sha=tag.commit.sha,
    	)
    	for tag in paginate(self.partial_api(self.api.repo_list_tags))
    	)

• repeated parameters in the API

  • function
    

    ogr/ogr/services/forgejo/project.py

    Lines 55 to 82 in 9c5d2d5

    	@property
    	def api(self) -> RepositoryClient:
    	"""Returns a `RepositoryClient` from pyforgejo. Helper to save some
    	typing.
    	"""
    	return self.service.api.repository
    	def partial_api(self, method, /, *args, **kwargs):
    	"""Returns a partial API call for `ForgejoProject`.
    	Injects `owner` and `repo` for the calls to `/repository/` endpoints.
    	Args:
    	method: Specific method on the Pyforgejo API that is to be wrapped.
    	*args: Positional arguments that get injected into every call.
    	**kwargs: Keyword-arguments that get injected into every call.
    	Returns:
    	Callable with pre-injected parameters.
    	"""
    	return partial(
    	method,
    	*args,
    	**kwargs,
    	owner=self.namespace,
    	repo=self.repo,
    	)

    I think you don't have much choice than to copy the partial_api and create another .api property on the ForgejoIssue that would return a reference to the issue API endpoint (rather than the repository one as on the project)

  • usage

    ogr/ogr/services/forgejo/project.py

    Lines 109 to 111 in 9c5d2d5

    	@description.setter
    	def description(self, new_description: str) -> None:
    	self.partial_api(self.api.repo_edit)(description=new_description)

[mynk8]

I will implement them as iterators. Thanks for the suggestions; they were much needed.