mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-04-17 23:11:29 +00:00
Code Issues Releases Wiki Activity

Add registryLockEmailAddress field to User object (#2418)

Browse Source 
We've added the field in the database in a previous PR. This is only
used in the old console for now because the new console does not have
registry lock functionality yet
This commit is contained in:
gbrodman
2024-05-09 17:42:45 -04:00
committed by GitHub
parent 808432e709
commit 7b34659a8f
12 changed files with 142 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/src/main/java/google/registry/model/console/User.java
View File

@@ -14,7 +14,6 @@
package google.registry.model.console;
import google.registry.persistence.VKey;
import javax.persistence.Access;
import javax.persistence.AccessType;
@@ -58,6 +57,5 @@ public class User extends UserBase {
public Builder(User user) {
super(user);
}
}
}

15
core/src/main/java/google/registry/model/console/UserBase.java
View File

@@ -25,6 +25,8 @@ import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
import google.registry.model.Buildable;
import google.registry.model.UpdateAutoTimestampEntity;
import google.registry.util.PasswordUtils;
import java.util.Optional;
import javax.annotation.Nullable;
import javax.persistence.Access;
import javax.persistence.AccessType;
import javax.persistence.Column;
@@ -54,6 +56,9 @@ public class UserBase extends UpdateAutoTimestampEntity implements Buildable {
@Column(nullable = false)
String emailAddress;
/** Optional external email address to use for registry lock confirmation emails. */
@Column String registryLockEmailAddress;
/** Roles (which grant permissions) associated with this user. */
@Column(nullable = false)
UserRoles userRoles;
@@ -89,6 +94,10 @@ public class UserBase extends UpdateAutoTimestampEntity implements Buildable {
return emailAddress;
}
public Optional<String> getRegistryLockEmailAddress() {
return Optional.ofNullable(registryLockEmailAddress);
}
public UserRoles getUserRoles() {
return userRoles;
}
@@ -150,6 +159,12 @@ public class UserBase extends UpdateAutoTimestampEntity implements Buildable {
return thisCastToDerived();
}
public B setRegistryLockEmailAddress(@Nullable String registryLockEmailAddress) {
getInstance().registryLockEmailAddress =
registryLockEmailAddress == null ? null : checkValidEmail(registryLockEmailAddress);
return thisCastToDerived();
}
public B setUserRoles(UserRoles userRoles) {
checkArgumentNotNull(userRoles, "User roles cannot be null");
getInstance().userRoles = userRoles;

18
core/src/main/java/google/registry/tools/CreateOrUpdateUserCommand.java
View File

@@ -34,6 +34,14 @@ public abstract class CreateOrUpdateUserCommand extends ConfirmingCommand {
@Parameter(names = "--email", description = "Email address of the user", required = true)
String email;
@Nullable
@Parameter(
names = "--registry_lock_email_address",
description =
"Optional external email address to use for registry lock confirmation emails, or empty"
+ " to remove the field.")
private String registryLockEmailAddress;
@Nullable
@Parameter(
names = "--admin",
@@ -78,6 +86,16 @@ public abstract class CreateOrUpdateUserCommand extends ConfirmingCommand {
User.Builder builder =
(user == null) ? new User.Builder().setEmailAddress(email) : user.asBuilder();
builder.setUserRoles(userRolesBuilder.build());
// An empty registryLockEmailAddress indicates that we should remove the field
if (registryLockEmailAddress != null) {
if (registryLockEmailAddress.isEmpty()) {
builder.setRegistryLockEmailAddress(null);
} else {
builder.setRegistryLockEmailAddress(registryLockEmailAddress);
}
}
User newUser = builder.build();
UserDao.saveUser(newUser);
}

13
core/src/main/java/google/registry/ui/server/console/ConsoleRegistryLockAction.java
View File

@@ -150,20 +150,27 @@ public class ConsoleRegistryLockAction extends ConsoleApiAction {
}
}
String userEmail = user.getEmailAddress();
Optional<String> maybeRegistryLockEmail = user.getRegistryLockEmailAddress();
if (maybeRegistryLockEmail.isEmpty()) {
setFailedResponse(
"User has no registry lock email address", HttpStatusCodes.STATUS_CODE_BAD_REQUEST);
return;
}
String registryLockEmail = maybeRegistryLockEmail.get();
try {
tm().transact(
() -> {
RegistryLock registryLock =
isLock
? domainLockUtils.saveNewRegistryLockRequest(
domainName, registrarId, userEmail, isAdmin)
domainName, registrarId, registryLockEmail, isAdmin)
: domainLockUtils.saveNewRegistryUnlockRequest(
domainName,
registrarId,
isAdmin,
relockDurationMillis.map(Duration::new));
sendVerificationEmail(registryLock, userEmail, isLock);
sendVerificationEmail(registryLock, registryLockEmail, isLock);
});
} catch (IllegalArgumentException e) {
// Catch IllegalArgumentExceptions separately to give a nicer error message and code

3
core/src/main/java/google/registry/ui/server/registrar/RegistryLockPostAction.java
View File

@@ -199,7 +199,8 @@ public class RegistryLockPostAction implements Runnable, JsonActionRunner.JsonAc
checkArgument(
user.verifyRegistryLockPassword(postInput.password),
"Incorrect registry lock password for user");
return user.getEmailAddress();
return user.getRegistryLockEmailAddress()
.orElseThrow(() -> new IllegalArgumentException("User has no registry lock email address"));
}
private String verifyPasswordAndGetEmailLegacyUser(User user, RegistryLockPostInput postInput)

36
core/src/test/java/google/registry/tools/CreateUserCommandTest.java
View File

@@ -53,6 +53,17 @@ public class CreateUserCommandTest extends CommandTestCase<CreateUserCommand> {
verifyNoMoreInteractions(iamClient);
}
@Test
void testSuccess_registryLock() throws Exception {
runCommandForced(
"--email",
"user@example.test",
"--registry_lock_email_address",
"registrylockemail@otherexample.test");
assertThat(UserDao.loadUser("user@example.test").get().getRegistryLockEmailAddress())
.hasValue("registrylockemail@otherexample.test");
}
@Test
void testSuccess_admin() throws Exception {
runCommandForced("--email", "user@example.test", "--admin", "true");
@@ -101,4 +112,29 @@ public class CreateUserCommandTest extends CommandTestCase<CreateUserCommand> {
.isEqualTo("A user with email user@example.test already exists");
verifyNoMoreInteractions(iamClient);
}
@Test
void testFailure_badEmail() throws Exception {
assertThat(
assertThrows(
IllegalArgumentException.class,
() -> runCommandForced("--email", "this is not valid")))
.hasMessageThat()
.isEqualTo("Provided email this is not valid is not a valid email address");
}
@Test
void testFailure_badRegistryLockEmail() throws Exception {
assertThat(
assertThrows(
IllegalArgumentException.class,
() ->
runCommandForced(
"--email",
"user@example.test",
"--registry_lock_email_address",
"this is not valid")))
.hasMessageThat()
.isEqualTo("Provided email this is not valid is not a valid email address");
}
}

38
core/src/test/java/google/registry/tools/UpdateUserCommandTest.java
View File

@@ -38,6 +38,29 @@ public class UpdateUserCommandTest extends CommandTestCase<UpdateUserCommand> {
.build());
}
@Test
void testSuccess_registryLockEmail() throws Exception {
runCommandForced(
"--email",
"user@example.test",
"--registry_lock_email_address",
"registrylockemail@otherexample.test");
assertThat(UserDao.loadUser("user@example.test").get().getRegistryLockEmailAddress())
.hasValue("registrylockemail@otherexample.test");
}
@Test
void testSuccess_removeRegistryLockEmail() throws Exception {
UserDao.saveUser(
UserDao.loadUser("user@example.test")
.get()
.asBuilder()
.setRegistryLockEmailAddress("registrylock@otherexample.test")
.build());
runCommandForced("--email", "user@example.test", "--registry_lock_email_address", "");
assertThat(UserDao.loadUser("user@example.test").get().getRegistryLockEmailAddress()).isEmpty();
}
@Test
void testSuccess_admin() throws Exception {
assertThat(UserDao.loadUser("user@example.test").get().getUserRoles().isAdmin()).isFalse();
@@ -86,4 +109,19 @@ public class UpdateUserCommandTest extends CommandTestCase<UpdateUserCommand> {
.hasMessageThat()
.isEqualTo("User nonexistent@example.test not found");
}
@Test
void testFailure_badRegistryLockEmail() {
assertThat(
assertThrows(
IllegalArgumentException.class,
() ->
runCommandForced(
"--email",
"user@example.test",
"--registry_lock_email_address",
"this is not valid")))
.hasMessageThat()
.isEqualTo("Provided email this is not valid is not a valid email address");
}
}

12
core/src/test/java/google/registry/ui/server/console/ConsoleRegistryLockActionTest.java
View File

@@ -100,6 +100,7 @@ public class ConsoleRegistryLockActionTest {
user =
new User.Builder()
.setEmailAddress("user@theregistrar.com")
.setRegistryLockEmailAddress("registrylock@theregistrar.com")
.setUserRoles(
new UserRoles.Builder()
.setRegistrarRoles(
@@ -436,6 +437,15 @@ public class ConsoleRegistryLockActionTest {
.isEqualTo("Registry lock not allowed for registrar TheRegistrar");
}
@Test
void testPost_failure_noRegistryLockEmail() {
user = user.asBuilder().setRegistryLockEmailAddress(null).build();
action = createDefaultPostAction(true);
action.run();
assertThat(response.getStatus()).isEqualTo(HttpStatusCodes.STATUS_CODE_BAD_REQUEST);
assertThat(response.getPayload()).isEqualTo("User has no registry lock email address");
}
@Test
void testPost_failure_badPassword() throws Exception {
action = createPostAction("example.test", true, "badPassword", Optional.empty());
@@ -534,6 +544,6 @@ public class ConsoleRegistryLockActionTest {
assertThat(sentMessage.subject()).matches("Registry (un)?lock verification");
assertThat(sentMessage.body()).matches(EMAIL_MESSAGE_TEMPLATE);
assertThat(sentMessage.recipients())
.containsExactly(new InternetAddress("user@theregistrar.com"));
.containsExactly(new InternetAddress("registrylock@theregistrar.com"));
}
}

3
core/src/test/java/google/registry/ui/server/registrar/RegistryLockPostActionTest.java
View File

@@ -218,6 +218,7 @@ final class RegistryLockPostActionTest {
google.registry.model.console.User consoleUser =
new google.registry.model.console.User.Builder()
.setEmailAddress("johndoe@theregistrar.com")
.setRegistryLockEmailAddress("johndoe.registrylock@theregistrar.com")
.setUserRoles(
new UserRoles.Builder()
.setRegistrarRoles(
@@ -229,7 +230,7 @@ final class RegistryLockPostActionTest {
AuthResult consoleAuthResult = AuthResult.createUser(UserAuthInfo.create(consoleUser));
action = createAction(consoleAuthResult);
Map<String, ?> response = action.handleJsonRequest(lockRequest());
assertSuccess(response, "lock", "johndoe@theregistrar.com");
assertSuccess(response, "lock", "johndoe.registrylock@theregistrar.com");
}
@Test

12
db/src/main/resources/sql/er_diagram/brief_er_diagram.html
View File

@@ -261,7 +261,7 @@ td.section {
</tr>
<tr>
<td class="property_name">generated on</td>
<td class="property_value">2024-05-01 21:04:48.5296048</td>
<td class="property_value">2024-05-09 17:59:02.29076074</td>
</tr>
<tr>
<td class="property_name">last flyway file</td>
@@ -277,11 +277,11 @@ td.section {
SchemaCrawler_Diagram
</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-3493.5 4025,-3493.5 4025,4 -4,4" />
<text text-anchor="start" x="3745" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated by</text>
<text text-anchor="start" x="3828" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">SchemaCrawler 16.10.1</text>
<text text-anchor="start" x="3744" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated on</text>
<text text-anchor="start" x="3828" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">2024-05-01 21:04:48.5296048</text>
<polygon fill="none" stroke="#888888" points="3741,-4 3741,-44 4013,-44 4013,-4 3741,-4" /> <!-- allocationtoken_a08ccbef -->
<text text-anchor="start" x="3737" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated by</text>
<text text-anchor="start" x="3820" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">SchemaCrawler 16.10.1</text>
<text text-anchor="start" x="3736" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated on</text>
<text text-anchor="start" x="3820" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">2024-05-09 17:59:02.29076074</text>
<polygon fill="none" stroke="#888888" points="3733,-4 3733,-44 4013,-44 4013,-4 3733,-4" /> <!-- allocationtoken_a08ccbef -->
<g id="node1" class="node">
<title>
allocationtoken_a08ccbef

4
db/src/main/resources/sql/er_diagram/full_er_diagram.html
View File

@@ -261,7 +261,7 @@ td.section {
</tr>
<tr>
<td class="property_name">generated on</td>
<td class="property_value">2024-05-01 21:04:45.792776047</td>
<td class="property_value">2024-05-09 17:58:59.761656939</td>
</tr>
<tr>
<td class="property_name">last flyway file</td>
@@ -280,7 +280,7 @@ td.section {
<text text-anchor="start" x="4443.5" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated by</text>
<text text-anchor="start" x="4526.5" y="-29.8" font-family="Helvetica,sans-Serif" font-size="14.00">SchemaCrawler 16.10.1</text>
<text text-anchor="start" x="4442.5" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">generated on</text>
<text text-anchor="start" x="4526.5" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">2024-05-01 21:04:45.792776047</text>
<text text-anchor="start" x="4526.5" y="-10.8" font-family="Helvetica,sans-Serif" font-size="14.00">2024-05-09 17:58:59.761656939</text>
<polygon fill="none" stroke="#888888" points="4439,-4 4439,-44 4726,-44 4726,-4 4439,-4" /> <!-- allocationtoken_a08ccbef -->
<g id="node1" class="node">
<title>

2
db/src/main/resources/sql/schema/db-schema.sql.generated
View File

@@ -882,6 +882,7 @@
id bigserial not null,
update_timestamp timestamptz,
email_address text not null,
registry_lock_email_address text,
registry_lock_password_hash text,
registry_lock_password_salt text,
global_role text not null,
@@ -899,6 +900,7 @@
history_url text not null,
user_id int8 not null,
email_address text not null,
registry_lock_email_address text,
registry_lock_password_hash text,
registry_lock_password_salt text,
global_role text not null,