seg_yinzy
/
che-server
mirror of https://github.com/eclipse-che/che-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add workspace maximum time che property 

Signed-off-by: Tom George <tgeorge@redhat.com>
7.20.x
Tom George 2020-07-02 20:26:42 -05:00
parent 3b2dbca536
commit a379daf78e
No known key found for this signature in database
GPG Key ID: 5EA5B2F05A51EF05
13 changed files with 146 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/multiuser.properties
View File

@ -40,6 +40,10 @@ che.limits.workspace.env.ram=16gb
# counts toward idleness.
che.limits.workspace.idle.timeout=1800000
# The length of time that a workspace will run, regardless of activity, before
# the system will suspend it.
che.limits.workspace.run.timeout=0
### Users workspace limits
# The total amount of RAM that a single user is allowed to allocate to running

7
multiuser/api/che-multiuser-api-workspace-activity/src/main/java/org/eclipse/che/multiuser/api/workspace/activity/MultiUserWorkspaceActivityManager.java
View File

@ -46,6 +46,7 @@ public class MultiUserWorkspaceActivityManager extends WorkspaceActivityManager
private final AccountManager accountManager;
private final ResourceManager resourceManager;
private final long defaultTimeout;
private final long runTimeout;
@Inject
public MultiUserWorkspaceActivityManager(
@ -54,11 +55,13 @@ public class MultiUserWorkspaceActivityManager extends WorkspaceActivityManager
EventService eventService,
AccountManager accountManager,
ResourceManager resourceManager,
@Named("che.limits.workspace.idle.timeout") long defaultTimeout) {
super(workspaceManager, activityDao, eventService, defaultTimeout);
@Named("che.limits.workspace.idle.timeout") long defaultTimeout,
@Named("che.limits.workspace.run.timeout") long runTimeout) {
super(workspaceManager, activityDao, eventService, defaultTimeout, runTimeout);
this.accountManager = accountManager;
this.resourceManager = resourceManager;
this.defaultTimeout = defaultTimeout;
this.runTimeout = runTimeout;
}
@Override

4
multiuser/api/che-multiuser-api-workspace-activity/src/test/java/org/eclipse/che/multiuser/api/workspace/activity/MultiUserWorkspaceActivityManagerTest.java
View File

@ -35,6 +35,7 @@ import org.testng.annotations.Test;
public class MultiUserWorkspaceActivityManagerTest {
private static final long DEFAULT_TIMEOUT = 60_000L; // 1 minute
private static final long USER_LIMIT_TIMEOUT = 120_000L; // 2 minutes
private static final long DEFAULT_HARD_EXPIRATION_TIMEOUT = 60000 * 60 * 3; // 3 hours
@Mock private AccountManager accountManager;
@Mock private ResourceManager resourceManager;
@ -58,7 +59,8 @@ public class MultiUserWorkspaceActivityManagerTest {
eventService,
accountManager,
resourceManager,
DEFAULT_TIMEOUT);
DEFAULT_TIMEOUT,
DEFAULT_HARD_EXPIRATION_TIMEOUT);
when(account.getId()).thenReturn("account123");
when(accountManager.getByName(anyString())).thenReturn(account);

7
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/InmemoryWorkspaceActivityDao.java
View File

@ -43,11 +43,14 @@ public class InmemoryWorkspaceActivityDao implements WorkspaceActivityDao {
}
@Override
public List<String> findExpired(long timestamp) {
public List<String> findExpired(long timestamp, long runTimeout) {
return workspaceActivities
.values()
.stream()
.filter(a -> a.getExpiration() != null && a.getExpiration() < timestamp)
.filter(
a ->
(a.getExpiration() != null && a.getExpiration() < timestamp)
|| (runTimeout > 0 && a.getLastRunning() - a.getLastStarting() > runTimeout))
.map(WorkspaceActivity::getWorkspaceId)
.collect(toList());
}

3
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/JpaWorkspaceActivityDao.java
View File

@ -52,12 +52,13 @@ public class JpaWorkspaceActivityDao implements WorkspaceActivityDao {
@Override
@Transactional(rollbackOn = ServerException.class)
public List<String> findExpired(long timestamp) throws ServerException {
public List<String> findExpired(long timestamp, long runTimeout) throws ServerException {
try {
return managerProvider
.get()
.createNamedQuery("WorkspaceActivity.getExpired", WorkspaceActivity.class)
.setParameter("expiration", timestamp)
.setParameter("runTimeout", runTimeout)
.getResultList()
.stream()
.map(WorkspaceActivity::getWorkspaceId)

11
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/WorkspaceActivity.java
View File

@ -27,7 +27,11 @@ import org.eclipse.che.api.core.model.workspace.WorkspaceStatus;
@NamedQueries({
@NamedQuery(
name = "WorkspaceActivity.getExpired",
query = "SELECT a FROM WorkspaceActivity a WHERE a.expiration < :expiration"),
query =
"SELECT a FROM WorkspaceActivity a WHERE a.expiration < :expiration OR "
+ "(a.status = org.eclipse.che.api.core.model.workspace.WorkspaceStatus.RUNNING AND "
+ ":runTimeout > 0 AND "
+ ":expiration - a.lastRunning > :runTimeout)"),
@NamedQuery(
name = "WorkspaceActivity.getStoppedSince",
query =
@ -165,6 +169,10 @@ public class WorkspaceActivity {
this.expiration = expiration;
}
public Long getRunTimeout() {
return this.lastRunning - this.lastStarting;
}
public WorkspaceStatus getStatus() {
return status;
}
@ -181,6 +189,7 @@ public class WorkspaceActivity {
if (o == null || getClass() != o.getClass()) {
return false;
}
WorkspaceActivity activity = (WorkspaceActivity) o;
return Objects.equals(workspaceId, activity.workspaceId)
&& Objects.equals(created, activity.created)

4
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/WorkspaceActivityChecker.java
View File

@ -101,7 +101,9 @@ public class WorkspaceActivityChecker {
private void stopAllExpired() {
try {
activityDao.findExpired(clock.millis()).forEach(this::stopExpiredQuietly);
activityDao
.findExpired(clock.millis(), workspaceActivityManager.getRunTimeout())
.forEach(this::stopExpiredQuietly);
} catch (ServerException e) {
LOG.error("Failed to list all expired to perform stop. Cause: {}", e.getMessage(), e);
}

3
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/WorkspaceActivityDao.java
View File

@ -46,10 +46,11 @@ public interface WorkspaceActivityDao {
* Finds workspaces which are passed given expiration time and must be stopped.
*
* @param timestamp expiration time
* @param runTimeout time after which the workspace will be stopped regardless of activity
* @return list of workspaces which expiration time is older than given timestamp
* @throws ServerException when operation failed
*/
List<String> findExpired(long timestamp) throws ServerException;
List<String> findExpired(long timestamp, long runTimeout) throws ServerException;
/**
* Removes the activity record of the provided workspace.

19
wsmaster/che-core-api-workspace-activity/src/main/java/org/eclipse/che/api/workspace/activity/WorkspaceActivityManager.java
View File

@ -54,6 +54,7 @@ public class WorkspaceActivityManager {
private static final Logger LOG = LoggerFactory.getLogger(WorkspaceActivityManager.class);
private final long defaultTimeout;
private final long runTimeout;
private final WorkspaceActivityDao activityDao;
private final EventService eventService;
private final EventSubscriber<WorkspaceStatusEvent> updateStatusChangedTimestampSubscriber;
@ -69,9 +70,16 @@ public class WorkspaceActivityManager {
WorkspaceManager workspaceManager,
WorkspaceActivityDao activityDao,
EventService eventService,
@Named("che.limits.workspace.idle.timeout") long timeout) {
@Named("che.limits.workspace.idle.timeout") long timeout,
@Named("che.limits.workspace.run.timeout") long runTimeout) {
this(workspaceManager, activityDao, eventService, timeout, Clock.systemDefaultZone());
this(
workspaceManager,
activityDao,
eventService,
timeout,
runTimeout,
Clock.systemDefaultZone());
}
@VisibleForTesting
@ -80,11 +88,13 @@ public class WorkspaceActivityManager {
WorkspaceActivityDao activityDao,
EventService eventService,
long timeout,
long runTimeout,
Clock clock) {
this.workspaceManager = workspaceManager;
this.eventService = eventService;
this.activityDao = activityDao;
this.defaultTimeout = timeout;
this.runTimeout = runTimeout;
this.clock = clock;
if (timeout > 0 && timeout < MINIMAL_TIMEOUT) {
LOG.warn(
@ -116,7 +126,6 @@ public class WorkspaceActivityManager {
activityDao.removeActivity(event.getWorkspace().getId());
}
};
this.updateStatusChangedTimestampSubscriber = new UpdateStatusChangedTimestampSubscriber();
}
@ -170,6 +179,10 @@ public class WorkspaceActivityManager {
return defaultTimeout;
}
protected long getRunTimeout() {
return runTimeout;
}
private class UpdateStatusChangedTimestampSubscriber
implements EventSubscriber<WorkspaceStatusEvent> {
@Override

11
wsmaster/che-core-api-workspace-activity/src/test/java/org/eclipse/che/api/workspace/activity/WorkspaceActivityCheckerTest.java
View File

@ -55,6 +55,8 @@ import org.testng.annotations.Test;
@Listeners(value = MockitoTestNGListener.class)
public class WorkspaceActivityCheckerTest {
private static final long DEFAULT_TIMEOUT = 60_000L; // 1 minute
private static final long DEFAULT_RUN_TIMEOUT = 0; // No default run timeout
private static final long ACTIVE_RUN_TIMEOUT = 60000 * 60 * 3; // 3 hours
private ManualClock clock;
private WorkspaceActivityChecker checker;
@ -69,7 +71,12 @@ public class WorkspaceActivityCheckerTest {
WorkspaceActivityManager activityManager =
new WorkspaceActivityManager(
workspaceManager, workspaceActivityDao, eventService, DEFAULT_TIMEOUT, clock);
workspaceManager,
workspaceActivityDao,
eventService,
DEFAULT_TIMEOUT,
DEFAULT_RUN_TIMEOUT,
clock);
lenient()
.when(workspaceActivityDao.getAll(anyInt(), anyLong()))
@ -88,7 +95,7 @@ public class WorkspaceActivityCheckerTest {
@Test
public void shouldStopAllExpiredWorkspaces() throws Exception {
when(workspaceActivityDao.findExpired(anyLong())).thenReturn(asList("1", "2", "3"));
when(workspaceActivityDao.findExpired(anyLong(), anyLong())).thenReturn(asList("1", "2", "3"));
checker.expire();

21
wsmaster/che-core-api-workspace-activity/src/test/java/org/eclipse/che/api/workspace/activity/WorkspaceActivityManagerTest.java
View File

@ -49,6 +49,8 @@ import org.testng.annotations.Test;
public class WorkspaceActivityManagerTest {
private static final long DEFAULT_TIMEOUT = 60_000L; // 1 minute
private static final long DEFAULT_RUN_TIMEOUT = 0; // No run timeout
private static final long ACTIVE_RUN_TIMEOUT = 60000 * 60 * 3; // 3 hours
@Mock private WorkspaceManager workspaceManager;
@ -68,7 +70,11 @@ public class WorkspaceActivityManagerTest {
private void setUp() throws Exception {
activityManager =
new WorkspaceActivityManager(
workspaceManager, workspaceActivityDao, eventService, DEFAULT_TIMEOUT);
workspaceManager,
workspaceActivityDao,
eventService,
DEFAULT_TIMEOUT,
DEFAULT_RUN_TIMEOUT);
lenient().when(account.getName()).thenReturn("accountName");
lenient().when(account.getId()).thenReturn("account123");
@ -102,6 +108,19 @@ public class WorkspaceActivityManagerTest {
assertEquals(wsIdCaptor.getValue(), wsId);
}
@Test
public void shouldRemoveRunTimeoutWhenWorkspaceStopped() throws Exception {
final String wsId = "testWsId";
final EventSubscriber<WorkspaceStatusEvent> subscriber = subscribeAndGetStatusEventSubscriber();
subscriber.onEvent(
DtoFactory.newDto(WorkspaceStatusEvent.class)
.withStatus(WorkspaceStatus.STOPPED)
.withWorkspaceId(wsId));
ArgumentCaptor<String> wsIdCaptor = ArgumentCaptor.forClass(String.class);
verify(workspaceActivityDao, times(1)).removeExpiration(wsIdCaptor.capture());
}
@Test
public void shouldCeaseToTrackTheWorkspaceActivityAfterStopping() throws Exception {
final String wsId = "testWsId";

68
wsmaster/che-core-api-workspace-activity/src/test/java/org/eclipse/che/api/workspace/activity/spi/tck/WorkspaceActivityDaoTest.java
View File

@ -12,8 +12,7 @@
package org.eclipse.che.api.workspace.activity.spi.tck;
import static java.util.Arrays.asList;
import static java.util.Collections.singletonList;
import static java.util.Collections.singletonMap;
import static java.util.Collections.*;
import static org.eclipse.che.api.core.model.workspace.WorkspaceStatus.STARTING;
import static org.eclipse.che.api.core.model.workspace.WorkspaceStatus.STOPPED;
import static org.testng.Assert.assertEquals;
@ -65,6 +64,8 @@ public class WorkspaceActivityDaoTest {
private static final int COUNT = 3;
private static final long DEFAULT_RUN_TIMEOUT = 0L;
@Inject private WorkspaceActivityDao workspaceActivityDao;
private AccountImpl[] accounts = new AccountImpl[COUNT];
@ -95,6 +96,7 @@ public class WorkspaceActivityDaoTest {
a.setExpiration(base * 1_000_000);
activities[i] = a;
System.out.println("activity is " + a);
}
accountTckRepository.createAll(asList(accounts));
@ -112,7 +114,7 @@ public class WorkspaceActivityDaoTest {
@Test
public void shouldFindExpirationsByTimestamp() throws Exception {
List<String> expected = asList(activities[0].getWorkspaceId(), activities[1].getWorkspaceId());
List<String> found = workspaceActivityDao.findExpired(2_500_000);
List<String> found = workspaceActivityDao.findExpired(2_500_000, DEFAULT_RUN_TIMEOUT);
assertEquals(found, expected);
}
@ -123,7 +125,22 @@ public class WorkspaceActivityDaoTest {
workspaceActivityDao.removeExpiration(activities[0].getWorkspaceId());
List<String> found = workspaceActivityDao.findExpired(2_500_000);
List<String> found = workspaceActivityDao.findExpired(2_500_000, DEFAULT_RUN_TIMEOUT);
assertEquals(found, expected);
}
@Test(dependsOnMethods = "shouldFindExpirationsByTimestamp")
public void shouldExpireWorkspaceThatExceedsRunTimeout() throws Exception {
List<String> expected = singletonList(activities[0].getWorkspaceId());
// Need more accurate activities for this test
workspaceActivityDao.removeActivity("ws0");
workspaceActivityDao.removeActivity("ws1");
workspaceActivityDao.removeActivity("ws2");
activityTckRepository.createAll(createWorkspaceActivitiesWithStatuses());
List<String> found = workspaceActivityDao.findExpired(8_000_000, 1_000_000);
assertEquals(found, expected);
}
@ -137,7 +154,7 @@ public class WorkspaceActivityDaoTest {
workspaceActivityDao.setExpirationTime(activities[2].getWorkspaceId(), 1_750_000);
List<String> found = workspaceActivityDao.findExpired(2_500_000);
List<String> found = workspaceActivityDao.findExpired(2_500_000, DEFAULT_RUN_TIMEOUT);
assertEquals(found, expected);
}
@ -160,7 +177,7 @@ public class WorkspaceActivityDaoTest {
// create new again
workspaceActivityDao.setExpirationTime(activities[1].getWorkspaceId(), 1_250_000);
List<String> found = workspaceActivityDao.findExpired(1_500_000);
List<String> found = workspaceActivityDao.findExpired(1_500_000, DEFAULT_RUN_TIMEOUT);
assertEquals(found, expected);
}
@ -286,6 +303,45 @@ public class WorkspaceActivityDaoTest {
.toArray(Object[][]::new);
}
/**
* Helper function that creates workspaces that are in the RUNNING and STOPPED state for
* shouldExpireWorkspaceThatExceedsRunTimeout
*
* @return A list of WorkspaceActivity objects
*/
private List<WorkspaceActivity> createWorkspaceActivitiesWithStatuses() {
WorkspaceActivity[] a = new WorkspaceActivity[3];
a[0] = new WorkspaceActivity();
a[0].setWorkspaceId("ws0");
a[0].setStatus(WorkspaceStatus.RUNNING);
a[0].setCreated(1_000_000);
a[0].setLastStarting(1_000_000);
a[0].setLastRunning(1_000_100);
a[0].setLastStopped(0);
a[0].setLastStopping(0);
a[0].setExpiration(1_100_000L);
a[1] = new WorkspaceActivity();
a[1].setWorkspaceId("ws1");
a[1].setStatus(WorkspaceStatus.RUNNING);
a[1].setCreated(7_000_000);
a[1].setLastStarting(7_000_000);
a[1].setLastRunning(7_100_000);
a[1].setLastStopped(0);
a[1].setLastStopping(0);
a[1].setExpiration(8_000_000L);
a[2] = new WorkspaceActivity();
a[2].setWorkspaceId("ws2");
a[2].setStatus(WorkspaceStatus.STOPPED);
a[2].setCreated(1_000_200);
a[2].setLastStarting(1_000_200);
a[2].setLastRunning(1_000_300);
a[2].setLastStopped(1_000_400);
a[2].setLastStopping(1_000_350);
return asList(a);
}
private static WorkspaceConfigImpl createWorkspaceConfig(String name) {
// Project Sources configuration
final SourceStorageImpl source1 = new SourceStorageImpl();

5
wsmaster/integration-tests/cascade-removal/src/test/java/org/eclipse/che/core/db/jpa/CascadeRemovalTest.java
View File

@ -239,6 +239,11 @@ public class CascadeRemovalTest {
bind(Long.class)
.annotatedWith(Names.named("che.limits.workspace.idle.timeout"))
.toInstance(100000L);
bind(Long.class)
.annotatedWith(Names.named("che.limits.workspace.run.timeout"))
.toInstance(0L);
bind(UserManager.class);
bind(AccountManager.class);