1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* Copyright (c) 2022 AtLarge Research
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.opendc.web.runner
import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.parameters.options.convert
import com.github.ajalt.clikt.parameters.options.default
import com.github.ajalt.clikt.parameters.options.defaultLazy
import com.github.ajalt.clikt.parameters.options.flag
import com.github.ajalt.clikt.parameters.options.option
import com.github.ajalt.clikt.parameters.types.file
import com.github.ajalt.clikt.parameters.types.int
import mu.KotlinLogging
import org.opendc.web.client.auth.OpenIdAuthController
import org.opendc.web.client.runner.OpenDCRunnerClient
import java.io.File
import java.net.URI
private val logger = KotlinLogging.logger {}
/**
* Represents the CLI command for starting the OpenDC web runner.
*/
class RunnerCli : CliktCommand(name = "opendc-runner") {
/**
* The URL to the OpenDC API.
*/
private val apiUrl by option(
"--api-url",
help = "url to the OpenDC API",
envvar = "OPENDC_API_URL",
)
.convert { URI(it) }
.default(URI("https://api.opendc.org/v2"))
/**
* Flag to disable authentication (for local development).
*/
private val noAuth by option(
"--no-auth",
help = "disable authentication (for local development)",
)
.flag()
/**
* The auth domain to use.
*/
private val authDomain by option(
"--auth-domain",
help = "auth domain of the OpenDC API",
envvar = "AUTH0_DOMAIN",
)
/**
* The auth audience to use.
*/
private val authAudience by option(
"--auth-audience",
help = "auth audience of the OpenDC API",
envvar = "AUTH0_AUDIENCE",
)
/**
* The auth client ID to use.
*/
private val authClientId by option(
"--auth-id",
help = "auth client id of the OpenDC API",
envvar = "AUTH0_CLIENT_ID",
)
/**
* The auth client secret to use.
*/
private val authClientSecret by option(
"--auth-secret",
help = "auth client secret of the OpenDC API",
envvar = "AUTH0_CLIENT_SECRET",
)
/**
* The path to the traces directory.
*/
private val tracePath by option(
"--traces",
help = "path to the directory containing the traces",
envvar = "OPENDC_TRACES",
)
.file(canBeFile = false)
.defaultLazy { File("traces/") }
/**
* The number of threads used for simulations..
*/
private val parallelism by option(
"--parallelism",
help = "maximum number of threads for simulations",
)
.int()
.default(Runtime.getRuntime().availableProcessors() - 1)
/**
* The maximum duration of a simulation job in minutes.
*/
private val jobTimeout by option(
"--job-timeout",
help = "maximum duration of a simulation job in minutes",
envvar = "OPENDC_JOB_TIMEOUT",
)
.int()
.default(10)
/**
* The interval to poll the API for new jobs in seconds.
*/
private val pollInterval by option(
"--poll-interval",
help = "interval to poll the API for new jobs in seconds",
envvar = "OPENDC_POLL_INTERVAL",
)
.int()
.default(30)
/**
* The interval to send a heartbeat to the API server in seconds.
*/
private val heartbeatInterval by option(
"--heartbeat-interval",
help = "interval to send a heartbeat to the API server in seconds",
envvar = "OPENDC_HEARTBEAT_INTERVAL",
)
.int()
.default(60)
override fun run() {
logger.info { "Starting OpenDC web runner" }
// Validate auth parameters if authentication is enabled
if (!noAuth) {
require(
authDomain != null,
) { "Auth domain is required when authentication is enabled. Use --no-auth to disable authentication." }
require(
authAudience != null,
) { "Auth audience is required when authentication is enabled. Use --no-auth to disable authentication." }
require(
authClientId != null,
) { "Auth client ID is required when authentication is enabled. Use --no-auth to disable authentication." }
require(authClientSecret != null) {
"Auth client secret is required when authentication is enabled. Use --no-auth to disable authentication."
}
}
val authController =
if (noAuth) {
logger.info { "Running without authentication" }
null
} else {
OpenIdAuthController(authDomain!!, authClientId!!, authClientSecret!!, authAudience!!)
}
val client = OpenDCRunnerClient(baseUrl = apiUrl, authController)
val manager = JobManager(client)
val runner =
OpenDCRunner(
manager,
tracePath,
parallelism = parallelism,
jobTimeout = java.time.Duration.ofMinutes(jobTimeout.toLong()),
pollInterval = java.time.Duration.ofSeconds(pollInterval.toLong()),
heartbeatInterval = java.time.Duration.ofSeconds(heartbeatInterval.toLong()),
)
logger.info { "Watching for queued scenarios" }
runner.run()
}
}
/**
* Main entry point of the runner.
*/
fun main(args: Array<String>): Unit = RunnerCli().main(args)
|
