CSS-6701 Rename `User` to `Identity` #1133

babakks · 2024-01-11T19:58:23Z

Description

This PR renames the User entity (in the internal/dbmodel package) to Identity.

Some notes/questions regarding this PR:

Should we rename the type UserModelDefaults to IdentityModelDefaults? (not renamed yet).
In 1_6.sql, do we need to rename these two instances as well? (not renamed).
- controllers.admin_user (to admin_identity_name).
- audit_log.user_tag (to identity_tag).

Fixes CSS-6701

Engineering checklist

Check only items that apply

Documentation updated
Covered by unit tests
Covered by integration tests

Signed-off-by: Babak K. Shandiz <[email protected]>

alesstimec

LGTM thank you for this - more LOC than i expected :)

As a bonus, it might be nice to fix the dockercompose too..

And the answer to other questions is, yes.

alesstimec · 2024-01-15T20:22:22Z

internal/dbmodel/version.go

@@ -20,7 +20,7 @@ const (
 	// Minor is the minor version of the model described in the dbmodel
 	// package. It should be incremented for any change made to the
 	// database model from database model in a released JIMM.
-	Minor = 5
+	Minor = 6


it could be argued that this is a major version change.. i'll leave it to you to decide.

I asked this question the other day, and I'm not sure which is the right way to go. But, an argument in favour of keeping it as a minor version bump, is that if consider it as a major change then it shouldn't rely on the existing schema and therefore we should create things from scratch (I mean, creating all tables, not just altering them). Since we're just applying the migration on the existing database schema, I think it's a bit more accurate to call it a minor change. But as I said, I'm open to discussion on the other approach.

Signed-off-by: Babak K. Shandiz <[email protected]>

Renamed UserModelDefaults to IdentityModelDefaults.

…s-03 Fixes for identitymodeldefaults.

kian99 · 2024-01-16T18:27:40Z

internal/dbmodel/sql/postgres/1_6.sql

+ALTER TABLE IF EXISTS user_model_defaults RENAME TO identity_model_defaults;
+
+-- TODO (CSS-6701): Do we need to rename these instances as well?
+--   - ALTER TABLE IF EXISTS controllers RENAME COLUMN admin_user TO admin_identity_name;


I think we should rename this.

The reason I didn't touch this one, is because there's another column in the same table, named admin_pass. So, I thought this is a username/password pair instance, rather than an identity as we're speaking of. Do you still think this should be changed?

I renamed it since @alesstimec also agrees with your suggestion.

kian99 · 2024-01-16T18:28:11Z

internal/dbmodel/sql/postgres/1_6.sql

+
+-- TODO (CSS-6701): Do we need to rename these instances as well?
+--   - ALTER TABLE IF EXISTS controllers RENAME COLUMN admin_user TO admin_identity_name;
+--   - ALTER TABLE IF EXISTS audit_log RENAME COLUMN user_tag TO identity_tag;


This too (but we shouldn't update the JSON unless we inform web team because that will break api compatability).

Yeah, I left the JSON and API spec as is.

kian99 · 2024-01-16T18:33:01Z

internal/dbmodel/sql/postgres/1_6.sql

+-- TODO (CSS-6701): Do we need to rename these instances as well?
+--   - ALTER TABLE IF EXISTS controllers RENAME COLUMN admin_user TO admin_identity_name;
+--   - ALTER TABLE IF EXISTS audit_log RENAME COLUMN user_tag TO identity_tag;
+--   - ALTER INDEX IF EXISTS idx_audit_log_user_tag RENAME TO idx_audit_log_identity_tag


And update this.

kian99 · 2024-01-16T18:33:49Z

internal/jimm/idenitymodeldefaults_test.go

This file name is misspelled, idenity -> identity

ale8k

lgtm

…dentity

Use default database (`postgres`) for Candid

Signed-off-by: Babak K. Shandiz <[email protected]>

…dentity

Signed-off-by: Babak K. Shandiz <[email protected]>

babakks added 23 commits January 11, 2024 13:38

Upgrade dbmodel version to v1.6

3ac8ea7

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename User type Identity

761f09e

Signed-off-by: Babak K. Shandiz <[email protected]>

Update Identity godoc

b87010c

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename identity_name column to identity

852c283

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename Identity.Username to Identity.Name

a89e77d

Signed-off-by: Babak K. Shandiz <[email protected]>

Update foreign-key tag

24f6f28

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename CloudCredential.OwnerUsername to OwnerIdentityName

aa1040a

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename CloudDefaults.Username to IdentityName

2303f29

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename Model.OwnerUsername to OwnerIdentityName

fa0456f

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename ApplicationOfferConnection.Username to IdentityName

53c820a

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename UserModelDefaults.Username to IdentityName

9e00838

Signed-off-by: Babak K. Shandiz <[email protected]>

Undo renaming controllers.admin_user and audit_log.user_tag columns

ca49edf

Signed-off-by: Babak K. Shandiz <[email protected]>

Update comment with Jira card ID

b721e12

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename CloudDefaults.User to Identity

bfcfa38

Signed-off-by: Babak K. Shandiz <[email protected]>

Update Gorm magic strings

d2ed00b

Signed-off-by: Babak K. Shandiz <[email protected]>

Fix more Gorm magic strings

e2c435c

Signed-off-by: Babak K. Shandiz <[email protected]>

Fix column name reference

d4c282c

Signed-off-by: Babak K. Shandiz <[email protected]>

Update error message

c1ea33b

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename indexes related to users

64671ae

Signed-off-by: Babak K. Shandiz <[email protected]>

Fix constraint name reference

2c4d4a2

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename dbmodel/user* files to dbmodel/identity*

b497c03

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename User CRUD methods to Identity

23182a5

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename db/user* files to db/identity*

4327628

Signed-off-by: Babak K. Shandiz <[email protected]>

babakks marked this pull request as ready for review January 15, 2024 13:56

babakks requested review from alesstimec, kian99, ale8k and mina1460 as code owners January 15, 2024 13:56

alesstimec approved these changes Jan 15, 2024

View reviewed changes

Use default database (postgres) for Candid

6819014

Signed-off-by: Babak K. Shandiz <[email protected]>

alesstimec added 4 commits January 16, 2024 19:03

Renamed UserModelDefaults to IdentityModelDefaults.

64229ab

Merge pull request #1 from alesstimec/rename-to-identity-user-defaults

158b9d5

Renamed UserModelDefaults to IdentityModelDefaults.

Fixes for identitymodeldefaults.

a69d6f5

Merge pull request #3 from alesstimec/rename-to-identity-user-default…

71e4926

…s-03 Fixes for identitymodeldefaults.

mina1460 approved these changes Jan 16, 2024

View reviewed changes

kian99 approved these changes Jan 16, 2024

View reviewed changes

ale8k approved these changes Jan 16, 2024

View reviewed changes

alesstimec and others added 11 commits January 17, 2024 02:40

Merge branch 'feature-serviceaccounts' into css-6701/rename-user-to-i…

1b7ea05

…dentity

Merge pull request #2 from babakks/use-postgres-default-db-for-candid

2d5b9ce

Use default database (`postgres`) for Candid

Rename misspelled file name

66daacc

Signed-off-by: Babak K. Shandiz <[email protected]>

Change the ordering of table and column renaming to match others

5bc41e4

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename user_model_defaults_username_fkey to identity_*

226090e

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename audit_log.user_tag column to identity_tag

96d2988

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename AuditLog.UserTag to IdentityTag

77a2eae

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename controllers.admin_user column to admin_identity_name

418a569

Signed-off-by: Babak K. Shandiz <[email protected]>

Rename Controller.AdminUser to AdminIdentityName

9611d80

Signed-off-by: Babak K. Shandiz <[email protected]>

Merge branch 'feature-serviceaccounts' into css-6701/rename-user-to-i…

140e97e

…dentity

Rename dbmodel.User reference to dbmodel.Identity

ce12615

Signed-off-by: Babak K. Shandiz <[email protected]>

alesstimec merged commit 9598679 into canonical:feature-serviceaccounts Jan 17, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSS-6701 Rename `User` to `Identity` #1133

CSS-6701 Rename `User` to `Identity` #1133

babakks commented Jan 11, 2024 •

edited

Loading

alesstimec left a comment

alesstimec Jan 15, 2024

babakks Jan 17, 2024

kian99 Jan 16, 2024

babakks Jan 17, 2024

babakks Jan 17, 2024

kian99 Jan 16, 2024

babakks Jan 17, 2024

kian99 Jan 16, 2024

babakks Jan 17, 2024

kian99 Jan 16, 2024

ale8k left a comment

CSS-6701 Rename User to Identity #1133

CSS-6701 Rename User to Identity #1133

Conversation

babakks commented Jan 11, 2024 • edited Loading

Description

Engineering checklist

alesstimec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ale8k left a comment

Choose a reason for hiding this comment

CSS-6701 Rename `User` to `Identity` #1133

CSS-6701 Rename `User` to `Identity` #1133

babakks commented Jan 11, 2024 •

edited

Loading