Add TasksCommand, rework system commands

Author: fonimus

README.md

@@ -11,24 +11,11 @@ For more information please visit `spring shell` [website](https://projects.spri
 or [2.0.1 reference documentation](https://docs.spring.io/spring-shell/docs/2.0.1.RELEASE/reference/htmlsingle/).
 
 * [Getting started](#getting-started)
-* [Actuator commands](#actuator-commands)
+* [Commands](#commands)
 * [Post processors](#post-processors)
-    * [Save](#save)
-    * [Pretty](#pretty)
-    * [Json](#json)
-    * [Grep](#grep)
-    * [Highlight](#highlight)
-    * [Custom](#custom)
 * [Parameter providers](#parameter-providers)
-    * [Enum](#enum)
-    * [File](#file)
-    * [Custom](#custom-values)
 * [Custom authentication](#custom-authentication)
 * [Command helper](#command-helper)
-    * [Print output](#print-output)
-    * [Read input](#read-input)
-    * [Table](#table)
-    * [Confirmation](#confirmation)
 * [Banner](#banner)
 * [Listeners](#listeners)
 * [Session Manager](#session-manager)
@@ -103,7 +90,7 @@ ssh:
         restricted: true
         authorized-roles: 
           - ADMIN
-      jvm: 
+      system: 
         enable: true
         restricted: true
         authorized-roles: 
@@ -119,13 +106,14 @@ ssh:
       postprocessors: 
         enable: true
         restricted: false
-      thread: 
-        enable: true
+      # since 1.3.0, command which allows you to list ssh sessions, and stop them
+      manage-sessions:
+        enable: false
         restricted: true
         authorized-roles: 
           - ADMIN
-      # since 1.3.0, command which allows you to list ssh sessions, and stop them
-      manage-sessions:
+      # since 1.5.0
+      tasks:
         enable: false
         restricted: true
         authorized-roles: 
@@ -214,12 +202,37 @@ public class TestCommands {
 }
 ``` 
 
-## Actuator commands
+## Commands
+
+All commands group can be deactivated by enable property :
+
+```yaml
+ssh:
+  shell:
+    commands:
+      <command>:
+        enable: true
+```
+
+Sub commands in group can be also filtered by includes and excludes properties :
+
+```yaml
+ssh:
+  shell:
+    commands:
+      <command>:
+        includes:
+          - xxx
+        excludes:
+          - xxx
+```
+
+### Actuator
 
 If `org.springframework.boot:spring-boot-starter-actuator` dependency is present, actuator commands
 will be available. 
 
-Command availability is binded to endpoint activation.
+Command availability is also bind to endpoint activation.
 
 ```yaml
 management:
@@ -228,16 +241,60 @@ management:
       enabled: false
 ```
 
-It can also be deactivated by putting command name is exclusion list.
+### Tasks
 
-```yaml
-ssh:
-  shell:
-    actuator:
-      excludes:
-      - audit
-      - ...
-``` 
+Activated by default if you have ``@EnableScheduling``, 
+these commands allow you to interact with spring boot scheduled tasks :
+
+* `tasks-list` : List scheduled tasks
+* `tasks-stop` : Stop one or all scheduled tasks
+* `tasks-restart` : Restart one or all scheduled tasks
+
+#### Task scheduler
+
+Based on spring documentation ``org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor.setScheduler``
+the task scheduler used for scheduled tasks will be :
+
+If not specified, it will look for unique bean of type ``TaskScheduler``, or with name
+``taskScheduler``. Otherwise a local single-threaded will be created.
+
+The ``TasksCommand`` keep the same mechanism in order to be able to restart stopped scheduled tasks.
+It also provides a ``setTaskScheduler()`` in case you want to specify custom one. 
+
+##### Examples
+
+| Context                                                                                                                                                    | Task scheduler used in TaskCommand
+| ---                                                                                                                                                        | ---
+| No ``TaskScheduler`` bean in context                                                                                                                       | Local single-threaded
+| One ``TaskScheduler`` bean named **ts** in context                                                                                                         | **ts** bean
+| Multiple ``TaskScheduler`` beans named **ts1**, **ts2** in context                                                                                         | Local single-threaded (could not find name **taskScheduler**)
+| Multiple ``TaskScheduler`` beans named **taskScheduler**, **ts2**, **ts3** in context                                                                      | **taskScheduler** bean
+| Task scheduler specified in method ``SchedulingConfigurer#configureTasks``                                                                                 | Local single-threaded (not set in task)
+| Task scheduler specified in method ``SchedulingConfigurer#configureTasks`` **AND** ``com.github.fonimus.ssh.shell.commands.TasksCommand.setTaskScheduler`` | Scheduler manually set
+
+
+### Jmx
+
+* `jmx-info`: Displays information about jmx mbean. Use -a option to query attribute values.
+* `jmx-invoke`: Invoke operation on object name.
+* `jmx-list`: List jmx mbeans.
+
+### System
+
+* `system-env`: List system environment.
+* `system-properties`: List system properties.
+* `system-threads`: List jvm threads.
+        
+### Datasource
+
+* `datasource-list`: List available datasources
+* `datasource-properties`: Datasource properties command. Executes 'show variables'
+* `datasource-query`: Datasource query command.
+* `datasource-update`: Datasource update command.
+
+### Post processors
+
+* `postprocessors`: Display the available post processors
 
 ## Post processors
 
@@ -654,7 +711,7 @@ public String myCommand() {
 
 ### Manage sessions commands
 
-If activated `ssh.shell.default-commands.manage-sessions=true`, the following commands are available :
+If activated `ssh.shell.commands.manage-sessions.enable=true`, the following commands are available :
 
 * `manage-sessions-info`: Displays information about single session
 * `manage-sessions-list`: Displays active sessions
@@ -684,6 +741,17 @@ public class ApplicationTest {}
 
 ## Release notes
 
+### 1.5.0
+
+* Add tasks commands : 
+    * ``tasks-list``
+    * ``tasks-stop``
+    * ``tasks-restart``
+* Rename commands :
+    * ``system-env`` instead of _jvm-env_
+    * ``system-properties`` instead of _jvm-properties_
+    * ``system-threads`` instead of _threads_
+
 ### 1.4.2
 
 * Rework commands properties (check [configuration chapter](#configuration)) to add the following :

pom.xml

@@ -20,7 +20,7 @@
 
     <groupId>com.github.fonimus</groupId>
     <artifactId>ssh-shell-spring-boot-parent</artifactId>
-    <version>1.4.3-SNAPSHOT</version>
+    <version>1.5.0-SNAPSHOT</version>
 
     <packaging>pom</packaging>
 

samples/basic/README.md

@@ -30,12 +30,6 @@
             script: Read and execute commands from a file.
             stacktrace: Display the full stacktrace of the last error.
     
-    Datasource Commands
-            datasource-list: List available datasources
-            datasource-properties: Datasource properties command. Executes 'show variables'
-            datasource-query: Datasource query command.
-            datasource-update: Datasource update command.
-    
     Demo Command
             authentication: Authentication command
             echo: Echo command
@@ -54,9 +48,9 @@
           * manage-sessions-stop: Stop session
     
     System Commands
-            jvm-env: List system environment.
-            jvm-properties: List system properties.
-            threads: Thread command.
+            system-env: List system environment.
+            system-properties: List system properties.
+            system-threads: Thread command.
     
     Commands marked with (*) are currently unavailable.
     Type `help <command>` to learn more.

samples/basic/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <artifactId>ssh-shell-spring-boot-parent</artifactId>
         <groupId>com.github.fonimus</groupId>
-        <version>1.4.3-SNAPSHOT</version>
+        <version>1.5.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

samples/complete/README.md

@@ -20,15 +20,15 @@
             _         _        _ _
       _____| |_    __| |_  ___| | |
      (_-<_-< ' \  (_-< ' \/ -_) | |
-     /__/__/_||_| /__/_||_\___|_|_| v1.0.1-SNAPSHOT
+     /__/__/_||_| /__/_||_\___|_|_| v1.5.0-SNAPSHOT
     
     
     Please type `help` to see available commands
     complete::>help
     AVAILABLE COMMANDS
     
     Actuator Commands
-            audit: Display audit endpoint.
+          * audit: Display audit endpoint.
             beans: Display beans endpoint.
             conditions: Display conditions endpoint.
             configprops: Display configprops endpoint.
@@ -42,7 +42,7 @@
             scheduledtasks: Display scheduledtasks endpoint.
           * sessions: Display sessions endpoint.
             shutdown: Shutdown application.
-            threaddump: Display threaddump endpoint.
+          * threaddump: Display threaddump endpoint.
     
     Built-In Commands
             clear: Clear the shell screen.
@@ -84,9 +84,14 @@
             manage-sessions-stop: Stop session
     
     System Commands
-            jvm-env: List system environment.
-            jvm-properties: List system properties.
-            threads: Thread command.
+            system-env: List system environment.
+            system-properties: List system properties.
+            system-threads: Thread command.
+    
+    Tasks Commands
+            tasks-list: Display the available scheduled tasks
+            tasks-restart: Restart all or specified task(s)
+            tasks-stop: Stop all or specified task(s)
     
     Commands marked with (*) are currently unavailable.
     Type `help <command>` to learn more.

samples/complete/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <artifactId>ssh-shell-spring-boot-parent</artifactId>
         <groupId>com.github.fonimus</groupId>
-        <version>1.4.3-SNAPSHOT</version>
+        <version>1.5.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

samples/complete/src/main/java/com/github/fonimus/ssh/shell/complete/DemoCommand.java

@@ -272,8 +272,24 @@ public String displaySshSession() {
      * For scheduled command example
      */
     @Scheduled(initialDelay = 0, fixedDelay = 60000)
-    public void log() {
-        LOGGER.info("In scheduled task..");
+    public void logWithDelay() {
+        LOGGER.info("In 'fixed-delay' scheduled task..");
+    }
+
+    /**
+     * For scheduled command example
+     */
+    @Scheduled(initialDelay = 0, fixedRate = 60000)
+    public void logWithRate() {
+        LOGGER.info("In 'fixed-rate' scheduled task..");
+    }
+
+    /**
+     * For scheduled command example
+     */
+    @Scheduled(cron = "0/60 * * * * *")
+    public void logWithCron() {
+        LOGGER.info("In 'cron' scheduled task..");
     }
 }
 

samples/complete/src/main/java/com/github/fonimus/ssh/shell/complete/DemoConfiguration.java

@@ -16,6 +16,7 @@
 
 package com.github.fonimus.ssh.shell.complete;
 
+import com.github.fonimus.ssh.shell.commands.TasksCommand;
 import com.github.fonimus.ssh.shell.listeners.SshShellListener;
 import com.github.fonimus.ssh.shell.postprocess.PostProcessor;
 import lombok.extern.slf4j.Slf4j;
@@ -24,6 +25,10 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
+import org.springframework.scheduling.TaskScheduler;
+import org.springframework.scheduling.annotation.SchedulingConfigurer;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
+import org.springframework.scheduling.config.ScheduledTaskRegistrar;
 
 import javax.sql.DataSource;
 import java.util.List;
@@ -33,7 +38,13 @@
  */
 @Slf4j
 @Configuration
-public class DemoConfiguration {
+public class DemoConfiguration implements SchedulingConfigurer {
+
+    private final TasksCommand tasksCommand;
+
+    public DemoConfiguration(TasksCommand tasksCommand) {
+        this.tasksCommand = tasksCommand;
+    }
 
     @Bean
     public PostProcessor<String> quotePostProcessor() {
@@ -84,4 +95,34 @@ public DataSourceProperties secondDsProps() {
     public DataSource secondDataSource() {
         return secondDsProps().initializeDataSourceBuilder().build();
     }
+
+    @Bean
+    public TaskScheduler taskScheduler() {
+        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
+        threadPoolTaskScheduler.setPoolSize(5);
+        threadPoolTaskScheduler.setThreadNamePrefix("my-pool-");
+        return threadPoolTaskScheduler;
+    }
+
+    @Bean
+    public TaskScheduler threadPoolTaskExecutor2() {
+        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
+        threadPoolTaskScheduler.setPoolSize(6);
+        threadPoolTaskScheduler.setThreadNamePrefix("my-pool2-");
+        return threadPoolTaskScheduler;
+    }
+
+    @Override
+    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
+        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
+
+        scheduler.setPoolSize(10);
+        scheduler.setThreadNamePrefix("my-scheduled-task-pool-");
+        scheduler.initialize();
+
+        taskRegistrar.setTaskScheduler(scheduler);
+        tasksCommand.setTaskScheduler(scheduler);
+
+        taskRegistrar.addCronTask(() -> LOGGER.info("In 'cron' scheduled task (registrar).."), "0/60 * * * * *");
+    }
 }

samples/complete/src/test/java/com/github/fonimus/ssh/shell/complete/DemoCommandTest.java

@@ -86,7 +86,8 @@ void testCommandEx() {
 
     @Test
     void testLog() {
-        cmd.log();
+        cmd.logWithCron();
+        cmd.logWithDelay();
     }
 
     @Test