-
Notifications
You must be signed in to change notification settings - Fork 154
/
AdminCLI.scala
318 lines (269 loc) · 14 KB
/
AdminCLI.scala
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
/*
* Copyright 2019 ABSA Group Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package za.co.absa.spline.admin
import ch.qos.logback.classic.{Level, Logger}
import org.slf4j.Logger.ROOT_LOGGER_NAME
import org.slf4j.LoggerFactory
import scopt.{OptionDef, OptionParser}
import za.co.absa.spline.admin.AdminCLI.AdminCLIConfig
import za.co.absa.spline.admin.DateTimeUtils.parseZonedDateTime
import za.co.absa.spline.arango.AuxiliaryDBAction._
import za.co.absa.spline.arango.OnDBExistsAction.{Drop, Fail, Skip}
import za.co.absa.spline.arango.{ArangoManagerFactory, ArangoManagerFactoryImpl}
import za.co.absa.spline.common.ConsoleUtils._
import za.co.absa.spline.common.SplineBuildInfo
import za.co.absa.spline.common.scala13.Option
import za.co.absa.spline.common.security.TLSUtils
import za.co.absa.spline.persistence.ArangoConnectionURL
import za.co.absa.spline.persistence.model.CollectionDef
import scala.annotation.nowarn
import scala.concurrent.Await
import scala.concurrent.duration._
object AdminCLI extends App {
import scala.concurrent.ExecutionContext.Implicits._
case class AdminCLIConfig(
cmd: Command = null,
logLevel: Level = Level.INFO,
disableSslValidation: Boolean = false,
dryRun: Boolean = false,
nonInteractive: Boolean = false,
)
implicit class OptionParserOps(val p: OptionParser[AdminCLIConfig]) extends AnyVal {
def placeNewLine(): Unit = p.note("")
def dbCommandOptions: Seq[OptionDef[_, AdminCLIConfig]] = Seq(
p.arg[String]("<db_url>")
.required()
.text(s"ArangoDB connection string in the format: ${ArangoConnectionURL.HumanReadableFormat}")
.action { case (url, c@AdminCLIConfig(cmd: DBCommand, _, _, _, _)) => c.copy(cmd.dbUrl = ArangoConnectionURL(url)) }
)
}
private val dbManagerFactory = new ArangoManagerFactoryImpl(activeFailover = false)
private val maybeConsole = InputConsole.systemConsoleIfAvailable()
new AdminCLI(dbManagerFactory, maybeConsole).exec(args)
}
class AdminCLI(dbManagerFactory: ArangoManagerFactory, maybeConsole: Option[InputConsole]) {
import za.co.absa.spline.common.CollectionUtils.Implicits._
def exec(args: Array[String]): Unit = {
@nowarn val cliParser: OptionParser[AdminCLIConfig] = new OptionParser[AdminCLIConfig](AppConfig.Spline.CLI.Executable) {
import AdminCLI._
head(
s"""
|Spline Admin Tool
|Version: ${SplineBuildInfo.Version} (rev. ${SplineBuildInfo.Revision})
|""".stripMargin
)
help("help").text("Print this usage text.")
version('v', "version").text("Print version info.")
{
val logLevels = classOf[Level].getFields.collect { case f if f.getType == f.getDeclaringClass => f.getName }
val logLevelsString = logLevels.mkString(", ")
opt[String]('l', "log-level")
.text(s"Log level ($logLevelsString). Default is ${AdminCLIConfig().logLevel}.")
.validate(l => if (logLevels.contains(l.toUpperCase)) success else failure(s"<log-level> should be one of: $logLevelsString"))
.action((str, conf) => conf.copy(logLevel = Level.valueOf(str)))
}
opt[Unit]("disable-ssl-validation")
.text(s"Disable validation of self-signed SSL certificates. (Don't use on production).")
.action((_, conf) => conf.copy(disableSslValidation = true))
opt[Unit]("dry-run")
.text("Dry-run commands. No real modification will be made to the database.")
.action((_, conf) => {
println(ansi"%yellow{Dry-run mode activated}")
conf.copy(dryRun = true)
})
opt[Unit]("non-interactive")
.text(
"Non-interactive mode. "
+ "Skip the confirmation prompt and proceed with the command. "
+ "Use this option only if you know what prompts are there to be displayed, and you agree with them.")
.action((_, conf) => {
println(ansi"%yellow{Non-interactive mode activated}")
conf.copy(nonInteractive = true)
})
this.placeNewLine()
cmd("db-init")
.action((_, c) => c.copy(cmd = DBInit()))
.text("Initialize Spline database")
.children(
opt[Unit]('f', "force")
.text("Re-create the database if one already exists.")
.action { case (_, c@AdminCLIConfig(cmd: DBInit, _, _, _, _)) => c.copy(cmd.copy(force = true)) },
opt[Unit]('s', "skip")
.text("Skip existing database. Don't throw error, just end.")
.action { case (_, c@AdminCLIConfig(cmd: DBInit, _, _, _, _)) => c.copy(cmd.copy(skip = true)) },
opt[Map[String, Int]]("shard-num")
.text("Override number of shards per collection. Comma-separated key-value pairs, e.g. 'collectionA=2,collectionB=3'.")
.validate(_.values
.collectFirst { case v if v < 1 => failure(s"Shard number should be positive, but was $v") }
.getOrElse(success))
.action {
case (m, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(numShards = m.mapKeys(CollectionDef.forName))))
},
opt[Int]("shard-num-default")
.text("Override default number of shards.")
.validate(v => if (v < 1) failure(s"Shard number should be positive, but was $v") else success)
.action {
case (v, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(numShardsDefault = Some(v))))
},
opt[Map[String, String]]("shard-keys")
.text("Override shard keys per collection. Comma-separated key-value pairs, where value is a key name list separated by '+', e.g. 'collectionA=k1+k2,collectionB=k3'.")
.action {
case (m, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(shardKeys = m.map({
case (k, s) => CollectionDef.forName(k) -> s.split('+').map(_.trim).toSeq
}))))
},
opt[String]("shard-keys-default")
.text("Override default shard keys. Key names separated by '+' character, e.g. 'key1+key2+key3'.")
.action {
case (v, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(shardKeysDefault = Some(v.split('+').map(_.trim)))))
},
opt[Map[String, Int]]("repl-factor")
.text("Override replication factor per collection. Comma-separated key-value pairs, e.g. 'collectionA=2,collectionB=3'.")
.validate(_.values
.collectFirst { case v if v < 1 => failure(s"Replication factor should be positive, but was $v") }
.getOrElse(success))
.action {
case (m, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(replFactor = m.mapKeys(CollectionDef.forName))))
},
opt[Int]("repl-factor-default")
.text("Override default replication factor.")
.validate(v => if (v < 1) failure(s"Replication factor should be positive, but was $v") else success)
.action {
case (v, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(replFactorDefault = Some(v))))
},
opt[Unit]("wait-for-sync")
.text("Ensure the data is synchronized to disk before returning from a document CUD operation.")
.action {
case (_, c@AdminCLIConfig(cmd@DBInit(_, _, _, opts), _, _, _, _)) =>
c.copy(cmd.copy(options = opts.copy(waitForSync = true)))
}
)
.children(this.dbCommandOptions: _*)
this.placeNewLine()
cmd("db-upgrade")
.action((_, c) => c.copy(cmd = DBUpgrade()))
.text("Upgrade Spline database")
.children(this.dbCommandOptions: _*)
this.placeNewLine()
cmd("db-exec")
.action((_, c) => c.copy(cmd = DBExec()))
.text("Auxiliary actions mainly intended for development, testing etc.")
.children(
opt[Unit]("check-access")
.text("Check access to the database")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(CheckDBAccess)) },
opt[Unit]("foxx-reinstall")
.text("Reinstall Foxx services")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(FoxxReinstall)) },
opt[Unit]("indices-delete")
.text("Delete indices")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(IndicesDelete)) },
opt[Unit]("indices-create")
.text("Create indices")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(IndicesCreate)) },
opt[Unit]("search-views-delete")
.text("Delete search views")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(SearchViewsDelete)) },
opt[Unit]("search-views-create")
.text("Create search views")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(SearchViewsCreate)) },
opt[Unit]("search-analyzers-delete")
.text("Delete search analyzers")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(SearchAnalyzerDelete)) },
opt[Unit]("search-analyzers-create")
.text("Create search analyzers")
.action { case (_, c@AdminCLIConfig(cmd: DBExec, _, _, _, _)) => c.copy(cmd.addAction(SearchAnalyzerCreate)) }
)
.children(this.dbCommandOptions: _*)
(cmd("db-prune")
action ((_, c) => c.copy(cmd = DBPrune()))
text "Prune old data to decrease the database footprint and speed up queries."
children (this.dbCommandOptions: _*)
children(
opt[String]("retain-for")
text "Retention period in format <length><unit>. " +
"Example: `--retain-for 30d` means to retain data that is NOT older than 30 days from now."
action { case (s, c@AdminCLIConfig(cmd: DBPrune, _, _, _, _)) => c.copy(cmd.copy(retentionPeriod = Some(Duration(s)))) },
opt[String]("before-date")
text "A datetime with an optional time and zone parts in ISO-8601 format. " +
"The data older than the specified datetime is subject for removal."
action { case (s, c@AdminCLIConfig(cmd: DBPrune, _, _, _, _)) => c.copy(cmd.copy(thresholdDate = Some(parseZonedDateTime(s)))) },
))
checkConfig {
case AdminCLIConfig(null, _, _, _, _) =>
failure("No command given")
case AdminCLIConfig(cmd: DBCommand, _, _, _, _) if cmd.dbUrl == null =>
failure("DB connection string is required")
case AdminCLIConfig(cmd: DBInit, _, _, _, _) if cmd.force && cmd.skip =>
failure("Options '--force' and '--skip' cannot be used together")
case AdminCLIConfig(cmd: DBPrune, _, _, _, _) if cmd.retentionPeriod.isEmpty && cmd.thresholdDate.isEmpty =>
failure("One of the following options must be specified: --retain-for or --before-date")
case AdminCLIConfig(cmd: DBPrune, _, _, _, _) if cmd.retentionPeriod.isDefined && cmd.thresholdDate.isDefined =>
failure("Options --retain-for and --before-date cannot be used together")
case _ =>
success
}
}
val conf = cliParser
.parse(args, AdminCLIConfig())
.getOrElse(sys.exit(1))
LoggerFactory
.getLogger(ROOT_LOGGER_NAME)
.asInstanceOf[Logger]
.setLevel(conf.logLevel)
val sslCtxOpt = Option.when(conf.disableSslValidation)(TLSUtils.TrustingAllSSLContext)
val userInteractor: UserInteractor =
if (conf.nonInteractive) ConfirmingUserInteractor
else maybeConsole
.map(new ConsoleUserInteractor(_))
.getOrElse(RejectingUserInteractor)
val interactiveDbManagerFactory = new InteractiveArangoManagerFactoryProxy(dbManagerFactory, userInteractor)
conf.cmd match {
case DBInit(url, force, skip, options) =>
val onExistsAction = (force, skip) match {
case (true, false) => Drop
case (false, true) => Skip
case _ => Fail
}
val dbManager = interactiveDbManagerFactory.create(url, sslCtxOpt, conf.dryRun)
val wasInitialized = Await.result(dbManager.createDatabase(onExistsAction, options), Duration.Inf)
if (!wasInitialized) println(ansi"%yellow{Skipped. DB is already initialized}")
case DBUpgrade(url) =>
val dbManager = interactiveDbManagerFactory.create(url, sslCtxOpt, conf.dryRun)
if (!userInteractor.confirmDatabaseBackupReady()) {
println(ansi"%red{ABORTED}")
System.exit(1)
}
Await.result(dbManager.upgrade(), Duration.Inf)
case DBExec(url, actions) =>
val dbManager = interactiveDbManagerFactory.create(url, sslCtxOpt, conf.dryRun)
Await.result(dbManager.execute(actions: _*), Duration.Inf)
case DBPrune(url, Some(retentionPeriod), _) =>
val dbManager = interactiveDbManagerFactory.create(url, sslCtxOpt, conf.dryRun)
Await.result(dbManager.prune(retentionPeriod), Duration.Inf)
case DBPrune(url, _, Some(dateTime)) =>
val dbManager = interactiveDbManagerFactory.create(url, sslCtxOpt, conf.dryRun)
Await.result(dbManager.prune(dateTime), Duration.Inf)
}
println(ansi"%green{DONE}")
}
}