resm 0.1.2

Remote Server Management tools
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
//! Utility commands to automate these tasks from a JSON file that summarizes
//! settings related to SSH connections to remote servers, application
//! deployment, etc.
//! 
//! # JSON format
//! 
//! ```json
//! [
//!     {
//!         "project": "project name",
//!         "environment": "dev",
//! 
//!         "remote_path": "path/to/remote/project/root",
//!         "remote_cache_path": "path/to/remote/project/cache",
//! 
//!         "git_path": "path/to/git/repo",
//!         "git_src_path": "path/to/git/src",
//!         "backup_path": "path/to/backup",
//! 
//!         "db_host": "db host name",
//!         "db_host_reader": "db host name for reader",
//!         "db_port": 3306,
//!         "db_name": "db name",
//!         "db_user": "db user",
//!         "db_password": "db password",
//!         "db_root_user": "db root user",
//!         "db_root_password": "db root password",
//! 
//!         "connect_info":
//!         {
//!             "host": "host name",
//!             "port": 22,
//!             "user": "user",
//!             "identity_file": "path/to/key_file"
//!         },
//! 
//!         "tunnels":
//!         [
//!             {
//!                 "host": "bastion host name",
//!                 "port": 22,
//!                 "user": "user",
//!                 "identity_file": "path/to/key_file"
//!             }
//!         ]
//!     }
//! ]
//! ```
//! 
//! ## Fields
//! 
//! Required fields are marked with an asterisk (*).
//! 
//! - project (*): Optional project name
//! - environment (*): Optional environment name
//! - remote_path: Reference path to be operated in the destination server
//!                (absolute path)
//! - remote_cache_path: Path to the cache directory in the destination server
//!                      (absolute path)
//! - git_path: Path to the git repository (absolute path)
//! - git_src_path: Path to the source directory in the git repository
//!                 (absolute path)
//! - backup_path: Path to the backup directory (absolute path)
//! - db_host: Host name of the database server
//! - db_host_reader: Host name of the database server for reader
//! - db_port: Port number of the database server
//! - db_name: Database name
//! - db_user: Database user name
//! - db_password: Database password
//! - db_root_user: Database root user name
//! - db_root_password: Database root password
//! - connect_info (*)
//!     - host (*): Host name or IP address to connect to
//!     - port: Port number of the server
//!     - user: User name
//!     - password: Password (Entering password cannot be omitted)
//!     - identity_file: Path to the identity file (absolute path)
//! - tunnels: Information on the step server to be passed through when
//!            connecting (array of connect_info)
//! 
//! 
//! # Commands
//! 
//! ## init
//! 
//! Generates SSH config file from the JSON file.
//! 
//! ## list
//! 
//! Lists projects.
//! 
//! ## show
//! 
//! Shows the project setting.
//! 
//! ## replace
//! 
//! Replaces the project directory in the destination server with the local
//! project directory. In short, it is useful when you want to perform a full
//! update of an application.
//! 
//! ## patch
//! 
//! Uploads only specified files in the local repository to the remote server.
//! 
//! ## clear
//! 
//! Clears the remote cache directory.
//! 
//! ## backup
//! 
//! Backs up the remote directory.
//! 
//! ## backup-db
//! 
//! Backs up the database.

#![allow(dead_code)]

mod connect_info;
mod ssh_config;
mod generate;
mod upload;
mod backup;
mod util;

use generate::generate_ssh_config;
use upload::{ upload_all, upload_patch, clear_cache };
use backup::{ backup, backup_db };
use util::{ load_json, get_session };

use std::env;

use clap::{ Parser, Subcommand };

//------------------------------------------------------------------------------
/// Parsed command line arguments.
//------------------------------------------------------------------------------
#[derive(Debug, Parser)]
#[command(
    name = "RESM - Remote Server Management tools",
    version = env!("CARGO_PKG_VERSION"),
    author = env!("CARGO_PKG_AUTHORS"),
)]
struct Cli
{
    #[command(subcommand)]
    subcommand: Subcommands,

    /// Path to the JSON file that summarizes the settings related to SSH
    /// connections to remote servers, application deployment, etc.
    #[clap(
        short = 'e',
        long,
        default_value = "",
    )]
    env_path: String,
}

//------------------------------------------------------------------------------
/// Subcommands.
//------------------------------------------------------------------------------
#[derive(Debug, Subcommand)]
enum Subcommands
{
    /// Generate SSH config file from the JSON file.
    Init,

    /// List projects.
    List,

    /// Show the project setting.
    Show
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,
    },

    /// Replace the project directory in the destination server with the local
    /// project directory.
    Replace
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,

        /// Relative path from the project directory that you want to upload.
        #[clap(
            short = 't',
            long,
            default_value = "",
        )]
        target_path: String,

        /// Whether to compress files when uploading.
        #[clap(
            long,
        )]
        zip: bool,
    },

    /// Upload only specified files in the local repository to the remote
    /// server.
    Patch
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,

        /// Path to the file that describes the files to be uploaded.
        #[clap(
            short = 'f',
            long,
            default_value = "",
        )]
        patch_file: String,
    },

    /// Clear the remote cache directory.
    Clear
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,
    },

    /// Back up the remote directory.
    Backup
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,

        ///  Relative path from the project directory that you want to backup.
        #[clap(
            short = 't',
            long,
            default_value = "",
        )]
        target_path: String,
    },

    /// Back up the database.
    BackupDb
    {
        /// Project name.
        #[clap(
            required = true,
        )]
        project: String,

        /// Specify table names to be backed up separated by commas (be careful
        /// not to include spaces, etc.)
        #[clap(
            short = 't',
            long,
            value_parser,
            num_args = 1..,
            value_delimiter = ',',
        )]
        target_tables: Vec<String>,
    },
}

#[tokio::main]
async fn main()
{
    let cli = Cli::parse();

    //  Loads JSON file.
    let env_path = if cli.env_path.len() > 0
    {
        cli.env_path
    }
    else
    {
        env::var("HOME").unwrap_or("".to_string()) + "/env"
    };
    let config_entries = load_json(&env_path);

    //  Executes subcommand.
    match cli.subcommand
    {
        Subcommands::Init => generate_ssh_config(&config_entries),
        Subcommands::List =>
        {
            let keys = config_entries.keys();
            for key in keys
            {
                println!("{}", key);
            }
        },
        Subcommands::Show { project } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                println!("{}", serde_json::to_string_pretty(&config).unwrap());
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        println!
                        (
                            "{}",
                            serde_json::to_string_pretty(&value).unwrap()
                        );
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        },
        Subcommands::Replace { project, target_path, zip } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                upload_all(&project, config, target_path, zip).await;
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        upload_all(&key, value, target_path.clone(), zip).await;
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        },
        Subcommands::Patch { project, patch_file } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                upload_patch(&project, config, patch_file).await;
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        upload_patch(&key, value, patch_file.clone()).await;
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        },
        Subcommands::Clear { project } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                let session = get_session(&project).await;
                clear_cache(&session, &config.remote_cache_path()).await;
                session.close().await.unwrap();
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        let session = get_session(&key).await;
                        clear_cache(&session, &value.remote_cache_path()).await;
                        session.close().await.unwrap();
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        }
        Subcommands::Backup { project, target_path } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                backup(&project, config, target_path).await;
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        backup(&key, value, target_path.clone()).await;
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        },
        Subcommands::BackupDb { project, target_tables } =>
        {
            if let Some(config) = config_entries.get(&project)
            {
                backup_db(&project, config, target_tables).await;
            }
            else
            {
                let mut found = false;
                for (key, value) in config_entries.iter()
                {
                    if key.starts_with(&project)
                    {
                        backup_db(&key, value, target_tables.clone()).await;
                        found = true;
                    }
                }

                if !found
                {
                    println!("Project not found.");
                }
                return;
            }
        },
    }
}