Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: refactor factor_test to centralize setup #1473

Merged
merged 3 commits into from
Mar 6, 2024
Merged

fix: refactor factor_test to centralize setup #1473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f66364a
fix: refactor factor test
Mar 6, 2024
f13081a
fix: remove unused method
Mar 6, 2024
b04b722
fix: proper not found error
Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 7 additions & 16 deletions internal/models/factor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,24 +153,15 @@ func FindFactorsByUser(tx *storage.Connection, user *User) ([]*Factor, error) {
return factors, nil
}

func FindFactorByFactorID(tx *storage.Connection, factorID uuid.UUID) (*Factor, error) {
factor, err := findFactor(tx, "id = ?", factorID)
if err != nil {
func FindFactorByFactorID(conn *storage.Connection, factorID uuid.UUID) (*Factor, error) {
var factor Factor
err := conn.Find(&factor, factorID)
if err != nil && errors.Cause(err) == sql.ErrNoRows {
return nil, FactorNotFoundError{}
} else if err != nil {
return nil, err
}
return factor, nil
}

func findFactor(tx *storage.Connection, query string, args ...interface{}) (*Factor, error) {
obj := &Factor{}
if err := tx.Eager().Q().Where(query, args...).First(obj); err != nil {
if errors.Cause(err) == sql.ErrNoRows {
return nil, FactorNotFoundError{}
}
return nil, errors.Wrap(err, "Database error finding factor")
}

return obj, nil
return &factor, nil
}

func DeleteUnverifiedFactors(tx *storage.Connection, user *User) error {
Expand Down
53 changes: 18 additions & 35 deletions internal/models/factor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ import (

type FactorTestSuite struct {
suite.Suite
db *storage.Connection
db *storage.Connection
TestFactor *Factor
}

func TestFactor(t *testing.T) {
Expand All @@ -32,58 +33,40 @@ func TestFactor(t *testing.T) {

func (ts *FactorTestSuite) SetupTest() {
TruncateAll(ts.db)
}

func (ts *FactorTestSuite) TestFindFactorByFactorID() {
f := ts.createFactor()
n, err := FindFactorByFactorID(ts.db, f.ID)
require.NoError(ts.T(), err)
require.Equal(ts.T(), f.ID, n.ID)
_, err = FindFactorByFactorID(ts.db, uuid.Nil)
require.EqualError(ts.T(), err, FactorNotFoundError{}.Error())
}

func (ts *FactorTestSuite) createFactor() *Factor {
user, err := NewUser("", "agenericemail@gmail.com", "secret", "test", nil)
require.NoError(ts.T(), err)

err = ts.db.Create(user)
require.NoError(ts.T(), err)
require.NoError(ts.T(), ts.db.Create(user))

factor := NewFactor(user, "asimplename", TOTP, FactorStateUnverified, "topsecret")
require.NoError(ts.T(), ts.db.Create(factor))
ts.TestFactor = factor
}

err = ts.db.Create(factor)
func (ts *FactorTestSuite) TestFindFactorByFactorID() {
n, err := FindFactorByFactorID(ts.db, ts.TestFactor.ID)
require.NoError(ts.T(), err)
require.Equal(ts.T(), ts.TestFactor.ID, n.ID)

return factor
_, err = FindFactorByFactorID(ts.db, uuid.Nil)
require.EqualError(ts.T(), err, FactorNotFoundError{}.Error())
}

func (ts *FactorTestSuite) TestUpdateStatus() {
newFactorStatus := FactorStateVerified
u, err := NewUser("", "", "", "", nil)
require.NoError(ts.T(), err)

f := NewFactor(u, "", TOTP, FactorStateUnverified, "some-secret")
require.NoError(ts.T(), f.UpdateStatus(ts.db, newFactorStatus))
require.Equal(ts.T(), newFactorStatus.String(), f.Status)
require.NoError(ts.T(), ts.TestFactor.UpdateStatus(ts.db, newFactorStatus))
require.Equal(ts.T(), newFactorStatus.String(), ts.TestFactor.Status)
}

func (ts *FactorTestSuite) TestUpdateFriendlyName() {
newSimpleName := "newFactorName"
u, err := NewUser("", "", "", "", nil)
require.NoError(ts.T(), err)

f := NewFactor(u, "A1B2C3", TOTP, FactorStateUnverified, "some-secret")
require.NoError(ts.T(), f.UpdateFriendlyName(ts.db, newSimpleName))
require.Equal(ts.T(), newSimpleName, f.FriendlyName)
newName := "newfactorname"
require.NoError(ts.T(), ts.TestFactor.UpdateFriendlyName(ts.db, newName))
require.Equal(ts.T(), newName, ts.TestFactor.FriendlyName)
}

func (ts *FactorTestSuite) TestEncodedFactorDoesNotLeakSecret() {
u, err := NewUser("", "", "", "", nil)
encodedFactor, err := json.Marshal(ts.TestFactor)
require.NoError(ts.T(), err)

f := NewFactor(u, "A1B2C3", TOTP, FactorStateUnverified, "some-secret")
encodedFactor, err := json.Marshal(f)
require.NoError(ts.T(), err)
decodedFactor := Factor{}
json.Unmarshal(encodedFactor, &decodedFactor)
require.Equal(ts.T(), decodedFactor.Secret, "")
Expand Down
Loading