domi/forgejo-domi
1
0
Fork 0
forked from forgejo/forgejo
Code Pull requests Activity

[F3] Forgejo driver and CLI

Browse source 
user, topic, project, label, milestone, repository, pull_request,
release, asset, comment, reaction, review providers

Signed-off-by: Earl Warren <contact@earl-warren.org>

Preserve file size when creating attachments

Introduced in c6f5029708

repoList.LoadAttributes has a ctx argument now

Rename `repo.GetOwner` to `repo.LoadOwner`

bd66fa586a

upgrade to the latest gof3

(cherry picked from commit c770713656)

[F3] ID remapping logic is in place, remove workaround

(cherry picked from commit d0fee30167)

[F3] it is experimental, do not enable by default

(cherry picked from commit de325b21d0)
(cherry picked from commit 547e7b3c40)
(cherry picked from commit 820df3a56b)
(cherry picked from commit eaba87689b)
(cherry picked from commit 1b86896b3b)
(cherry picked from commit 0046aac1c6)
(cherry picked from commit f14220df8f)
(cherry picked from commit 559b731001)
(cherry picked from commit 801f7d600d)
(cherry picked from commit 6aa76e9bcf)
(cherry picked from commit a8757dcb07)

[F3] promote F3 users to matching OAuth2 users on first sign-in

(cherry picked from commit bd7fef7496)
(cherry picked from commit 07412698e8)
(cherry picked from commit d143e5b2a3)

[F3] upgrade to gof3 50a6e740ac04

Add new methods GetIDString() & SetIDString() & ToFormatInterface()
Change the prototype of the fixture function

(cherry picked from commit d7b263ff8b)
(cherry picked from commit b3eaf2249d)
(cherry picked from commit d492ddd9bb)

[F3] add GetLocalMatchingRemote with a default implementation

(cherry picked from commit 0a22015039)
(cherry picked from commit f1310c38fb)
(cherry picked from commit deb68552f2)

[F3] GetLocalMatchingRemote for user

(cherry picked from commit e73cb837f5)
(cherry picked from commit a24bc0b85e)
(cherry picked from commit 846a522ecc)

[F3] GetAdminUser now has a ctx argument

(cherry picked from commit 37357a92af)
(cherry picked from commit 660bc1673c)
(cherry picked from commit 72d692a767)

[F3] introduce UserTypeF3

To avoid conflicts should UserTypeRemoteUser be used differently by Gitea

(cherry picked from commit 6de2701bb3)

[F3] user.Put: idempotency

(cherry picked from commit 821e38573c)
(cherry picked from commit f7638f5414)

[F3] upgrade to urfave v2

(cherry picked from commit cc3dbdfd1d)

[F3] update gof3

(cherry picked from commit 2eee960751)

[F3] move f3 under forgejo-cli

* simplify the tests by re-using the forgejo-cli helpers to capture
  the output
* unify CmdF3 to be structured in the same way CmdActions is

(cherry picked from commit 4c9fe58b74)

[F3] replace f3 with forgejo-cli f3

(cherry picked from commit 7ba7ceef1b)

[F3] s/ListOptions/Paginator/

[F3] user: add unit tests

[F3] user comparison of F3 managed users is on content

[F3] issue: add unit tests

[F3] gof3 now has one more argument to Put()

[F3] re-use gof3 unit tests for the driver

(cherry picked from commit af7ee6200c)

Conflicts:
	tests/integration/integration_test.go
	because of some code removed in forgejo-development, trivial
	context conflict resolution

[F3] more idempotent tests (#1275)

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/1275
Co-authored-by: Loïc Dachary <loic@dachary.org>
Co-committed-by: Loïc Dachary <loic@dachary.org>

[F3] tests: do SQL update if nothing changes

[F3] tests comment idempotence

[F3] tests milestone idempotence

[F3] tests pull_request idempotence

[F3] tests release idempotence

[F3] tests asset idempotence

[F3] tests project idempotence

[F3] tests review idempotence
This commit is contained in:
Earl Warren 2022-09-06 14:35:43 +10:00
parent 70fffdc61d
commit 91038bb4e8
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
40 changed files with 3944 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

257
services/f3/driver/user.go Normal file
View file

@ -0,0 +1,257 @@
// SPDX-License-Identifier: MIT
package driver
import (
"context"
"fmt"
"strings"
auth_model "code.gitea.io/gitea/models/auth"
"code.gitea.io/gitea/models/db"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/util"
user_service "code.gitea.io/gitea/services/user"
"lab.forgefriends.org/friendlyforgeformat/gof3/forges/common"
"lab.forgefriends.org/friendlyforgeformat/gof3/format"
f3_util "lab.forgefriends.org/friendlyforgeformat/gof3/util"
)
type User struct {
user_model.User
}
func UserConverter(f *user_model.User) *User {
return &User{
User: *f,
}
}
func (o User) GetID() int64 {
return o.ID
}
func (o User) GetIDString() string {
return fmt.Sprintf("%d", o.GetID())
}
func (o *User) SetID(id int64) {
o.ID = id
}
func (o *User) SetIDString(id string) {
o.SetID(f3_util.ParseInt(id))
}
func (o *User) IsNil() bool {
return o.ID == 0
}
func (o *User) Equals(other *User) bool {
//
// Only compare user data if both are managed by F3 otherwise
// they are equal if they have the same ID. Here is an example:
//
// * mirror from F3 to Forgejo => user jane created and assigned
// ID 213 & IsF3()
// * mirror from F3 to Forgejo => user jane username in F3 is updated
// the username for user ID 213 in Forgejo is also updated
// * user jane sign in with OAuth from the same source as the
// F3 mirror. They are promoted to IsIndividual()
// * mirror from F3 to Forgejo => user jane username in F3 is updated
// the username for user ID 213 in Forgejo is **NOT** updated, it
// no longer is managed by F3
//
if !o.IsF3() || !other.IsF3() {
return o.ID == other.ID
}
return (o.Name == other.Name &&
o.FullName == other.FullName &&
o.Email == other.Email)
}
func (o *User) ToFormatInterface() format.Interface {
return o.ToFormat()
}
func (o *User) ToFormat() *format.User {
return &format.User{
Common: format.NewCommon(o.ID),
UserName: o.Name,
Name: o.FullName,
Email: o.Email,
Password: o.Passwd,
}
}
func (o *User) FromFormat(user *format.User) {
*o = User{
User: user_model.User{
Type: user_model.UserTypeF3,
ID: user.Index.GetID(),
Name: user.UserName,
FullName: user.Name,
Email: user.Email,
Passwd: user.Password,
},
}
}
type UserProvider struct {
BaseProvider
}
func getLocalMatchingRemote(ctx context.Context, authenticationSource int64, id string) *user_model.User {
u := &user_model.User{
LoginName: id,
LoginSource: authenticationSource,
LoginType: auth_model.OAuth2,
Type: user_model.UserTypeIndividual,
}
has, err := db.GetEngine(ctx).Get(u)
if err != nil {
panic(err)
} else if !has {
return nil
}
return u
}
func (o *UserProvider) GetLocalMatchingRemote(ctx context.Context, format format.Interface, parents ...common.ContainerObjectInterface) (string, bool) {
authenticationSource := o.g.GetAuthenticationSource()
if authenticationSource == 0 {
return "", false
}
user := getLocalMatchingRemote(ctx, authenticationSource, format.GetIDString())
if user != nil {
o.g.GetLogger().Debug("found existing user %d with a matching authentication source for %s", user.ID, format.GetIDString())
return fmt.Sprintf("%d", user.ID), true
}
o.g.GetLogger().Debug("no pre-existing local user for %s", format.GetIDString())
return "", false
}
func (o *UserProvider) ToFormat(ctx context.Context, user *User) *format.User {
return user.ToFormat()
}
func (o *UserProvider) FromFormat(ctx context.Context, p *format.User) *User {
var user User
user.FromFormat(p)
return &user
}
func (o *UserProvider) GetObjects(ctx context.Context, page int) []*User {
sess := db.GetEngine(ctx).In("type", user_model.UserTypeIndividual, user_model.UserTypeF3)
if page != 0 {
sess = db.SetSessionPagination(sess, &db.ListOptions{Page: page, PageSize: o.g.perPage})
}
sess = sess.Select("`user`.*")
users := make([]*user_model.User, 0, o.g.perPage)
if err := sess.Find(&users); err != nil {
panic(fmt.Errorf("error while listing users: %v", err))
}
return f3_util.ConvertMap[*user_model.User, *User](users, UserConverter)
}
func (o *UserProvider) ProcessObject(ctx context.Context, user *User) {
}
func GetUserByName(ctx context.Context, name string) (*user_model.User, error) {
if len(name) == 0 {
return nil, user_model.ErrUserNotExist{Name: name}
}
u := &user_model.User{Name: name}
has, err := db.GetEngine(ctx).In("type", user_model.UserTypeIndividual, user_model.UserTypeF3).Get(u)
if err != nil {
return nil, err
} else if !has {
return nil, user_model.ErrUserNotExist{Name: name}
}
return u, nil
}
func (o *UserProvider) Get(ctx context.Context, exemplar *User) *User {
o.g.GetLogger().Debug("%+v", *exemplar)
var user *user_model.User
var err error
if exemplar.GetID() > 0 {
user, err = user_model.GetUserByID(ctx, exemplar.GetID())
o.g.GetLogger().Debug("%+v %v", user, err)
} else if exemplar.Name != "" {
user, err = GetUserByName(ctx, exemplar.Name)
} else {
panic("GetID() == 0 and UserName == \"\"")
}
if err != nil {
if user_model.IsErrUserNotExist(err) {
return &User{}
}
panic(fmt.Errorf("user %+v %w", *exemplar, err))
}
return UserConverter(user)
}
func (o *UserProvider) Put(ctx context.Context, user, existing *User) *User {
o.g.GetLogger().Trace("begin %+v", *user)
u := &user_model.User{
ID: user.GetID(),
Type: user_model.UserTypeF3,
}
//
// Get the user, if any
//
var has bool
var err error
if u.ID > 0 {
has, err = db.GetEngine(ctx).Get(u)
if err != nil {
panic(err)
}
}
//
// Set user information
//
u.Name = user.Name
u.LowerName = strings.ToLower(u.Name)
u.FullName = user.FullName
u.Email = user.Email
if !has {
//
// The user does not exist, create it
//
o.g.GetLogger().Trace("creating %+v", *u)
u.ID = 0
u.Passwd = user.Passwd
overwriteDefault := &user_model.CreateUserOverwriteOptions{
IsActive: util.OptionalBoolTrue,
}
err := user_model.CreateUser(u, overwriteDefault)
if err != nil {
panic(err)
}
} else {
//
// The user already exists, update it
//
o.g.GetLogger().Trace("updating %+v", *u)
if err := user_model.UpdateUserCols(ctx, u, "name", "lower_name", "email", "full_name"); err != nil {
panic(err)
}
}
r := o.Get(ctx, UserConverter(u))
o.g.GetLogger().Trace("finish %+v", r.User)
return r
}
func (o *UserProvider) Delete(ctx context.Context, user *User) *User {
u := o.Get(ctx, user)
if !u.IsNil() {
if err := user_service.DeleteUser(ctx, &user.User, true); err != nil {
panic(err)
}
}
return u
}