gitea github-runner test

[ChristopherHX]

This verifies github_runner scaler compatbility with https://github.com/go-gitea/gitea (v1.25.0)

Cloned the github_runner e2e test to run against a local Gitea instance of nightly

• Removed the cancel run
  • this e2e deploys a Gitea Server for testing into another namespace by default
• Replaced the workflow id by file names, Gitea currently do not support numeric ids of these endpoints
• Verifies GitHub Api Compatibility of Gitea
• github_runner can be tested without github.com
• added vendor/k8s.io/client-go/tools/portforward to allow the test controller to make Gitea Api calls
  • within kubernetes this is not used

Checklist

• Tests have been added
• A PR is opened to update the documentation on (repo) (if applicable)
  • Once Gitea side is merged and this test still passes
• Commits are signed with Developer Certificate of Origin (DCO - learn more)
• Use official Gitea images for test
  • Once Add workflow_run api + webhook go-gitea/gitea#33964 merged and we have an act_runner that accepts a PAT token via env

Further enhancements

• add a gitea_runner scaler
• allow gitea-global and gitea-user scope in github_runner
• implement paging when rate limiting is not enforced like on Gitea
• make Gitea Api calls within kubernetes instead of port forwarding
• add PAT runner creation in official image
• create more bigger act_runner images with more tools and ubuntu

Relates to #6488, go-gitea/gitea#33964

[ChristopherHX]

The e2e test should not require any secret token to work in your environment.

While there might be the possibility that such a test is not wanted for an existing autoscaler designed for github and instead duplicating the scaler for gitea is demanded.

BTW keda works now with gitea/gitea:nightly, even without this PR being part of keda

Out of draft, no longer custom images used in this e2e test.

[zroubalik]

/run-e2e gitea
Update: You can check the progress here

[zroubalik]

nit, could you please rename the file with the test?

gitea_runner_test.go -> github_runner_on_gitea_test.go

We use regexes to run e2e tests, renaming this file would trigger this test everytime we want to test github

Thanks!

[ChristopherHX]

Thank you for your feedback, I have renamed the test file to github_runner_on_gitea_test.go

After reading the e2e logs I noticed that I have to merge my two file intergation test into a single file.

Please retrigger the e2e test soon.

[rickbrouwer]

/run-e2e github*
Update: You can check the progress here

[JorTurFer]

This is nice but I don't fully understand the case. I mean, is gitea compatible with GH API? From this PR I think so, so maybe we should include this information in the scaler docs to make users aware of it. WDYT?

[ChristopherHX]

Thanks for your constructive review.

I mean, is gitea compatible with GH API?

Yes almost compatible for GH APIs in general ¹, e.g. go-github can be used to some extend.

WDYT?

Yes documenting this is good a idea.
Currently Gitea 1.25 has not been released yet. I am going to try to write some useful documentation for keda and Gitea.

I wonder should Gitea get it's own docs page and just provide a link in the GitHub Article that a Gitea Version of the doc is available as well?

Footnotes

1. GH API is large, small api incompatibilities/missing endpoints exist none of them is keda using right now. ↩

[JorTurFer]

I wonder should Gitea get it's own docs page and just provide a link in the GitHub Article that a Gitea Version of the doc is available as well?

More documentation is always better for end users, maybe you can document on your side or just a blogpost on keda.sh, as you prefer. Maybe we can just publish a blogpost explaining how to configure KEDA for scaling gitea runners and refer it on gitea docs (or just the opposite, document it on gitea page and link it in GH scaler)

[rickbrouwer]

I wonder should Gitea get it's own docs page and just provide a link in the GitHub Article that a Gitea Version of the doc is available as well?

More documentation is always better for end users, maybe you can document on your side or just a blogpost on keda.sh, as you prefer. Maybe we can just publish a blogpost explaining how to configure KEDA for scaling gitea runners and refer it on gitea docs (or just the opposite, document it on gitea page and link it in GH scaler)

The search function on keda.sh also searches the description. Would it be a good idea to edit the description so that the word "Gitea" is also mentioned there and thus easier to find?
I also think it would be fine to add a line to the Github scaler regarding Gitea, something like:

"Gitea uses the same API structure as GitHub, so you can use the github trigger type for Gitea repositories."

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.