Remove cruft from log output (#479)

app/data/stacks/test/deploy/commands.py

@@ -45,6 +45,13 @@ def init(command_context: DeployCommandContext):
     return yaml.load(default_spec_file_content)
 
 
+def create(command_context: DeployCommandContext):
+    data = "create-command-output-data"
+    output_file_path = command_context.deployment_dir.joinpath("create-file")
+    with open(output_file_path, 'w+') as output_file:
+        output_file.write(data)
+
+
 def get_state(command_context: DeployCommandContext):
     print("Here we get state")
     return State.CONFIGURED

app/deploy.py

@@ -144,14 +144,16 @@ def exec_operation(ctx, extra_args):
             print(f"container command returned error exit status")
 
 
-def logs_operation(ctx, extra_args):
+def logs_operation(ctx, tail: int, follow: bool, extra_args: str):
     global_context = ctx.parent.parent.obj
     extra_args_list = list(extra_args) or None
     if not global_context.dry_run:
         if global_context.verbose:
             print("Running compose logs")
-        logs_output = ctx.obj.docker.compose.logs(services=extra_args_list if extra_args_list is not None else [])
-        print(logs_output)
+        services_list = extra_args_list if extra_args_list is not None else []
+        logs_stream = ctx.obj.docker.compose.logs(services=services_list, tail=tail, follow=follow, stream=True)
+        for stream_type, stream_content in logs_stream:
+            print(stream_content.decode("utf-8"), end="")
 
 
 @command.command()
@@ -192,10 +194,12 @@ def exec(ctx, extra_args):
 
 
 @command.command()
+@click.option("--tail", "-n", default=None, help="number of lines to display")
+@click.option("--follow", "-f", is_flag=True, default=False, help="follow log output")
 @click.argument('extra_args', nargs=-1)  # help: command: logs <service1> <service2>
 @click.pass_context
-def logs(ctx, extra_args):
-    logs_operation(ctx, extra_args)
+def logs(ctx, tail, follow, extra_args):
+    logs_operation(ctx, tail, follow, extra_args)
 
 
 def get_stack_status(ctx, stack):

app/deployment.py

@@ -119,11 +119,13 @@ def exec(ctx, extra_args):
 
 
 @command.command()
+@click.option("--tail", "-n", default=None, help="number of lines to display")
+@click.option("--follow", "-f", is_flag=True, default=False, help="follow log output")
 @click.argument('extra_args', nargs=-1)  # help: command: logs <service1> <service2>
 @click.pass_context
-def logs(ctx, extra_args):
+def logs(ctx, tail, follow, extra_args):
     ctx.obj = make_deploy_context(ctx)
-    logs_operation(ctx, extra_args)
+    logs_operation(ctx, tail, follow, extra_args)
 
 
 @command.command()

app/deployment_create.py

@@ -205,7 +205,11 @@ def create(ctx, spec_file, deployment_dir):
                 if not os.path.exists(destination_config_dir):
                     copytree(source_config_dir, destination_config_dir)
     # Delegate to the stack's Python code
-    deployment_context = DeploymentContext(Path(deployment_dir), ctx.obj)
+    # The deploy create command doesn't require a --stack argument so we need to insert the
+    # stack member here.
+    deployment_command_context = ctx.obj
+    deployment_command_context.stack = stack_name
+    deployment_context = DeploymentContext(Path(deployment_dir), deployment_command_context)
     call_stack_deploy_create(deployment_context)
 
 

tests/deploy/run-deploy-test.sh

@@ -26,17 +26,18 @@ $TEST_TARGET_SO --stack test build-containers
 # Test deploy command execution
 $TEST_TARGET_SO --stack test deploy setup $CERC_REPO_BASE_DIR
 # Check that we now have the expected output directory
-if [ ! -d "$CERC_REPO_BASE_DIR/container-output-dir" ]; then
+container_output_dir=$CERC_REPO_BASE_DIR/container-output-dir
+if [ ! -d "$container_output_dir" ]; then
     echo "deploy setup test: output directory not present"
     echo "deploy setup test: FAILED"
     exit 1
 fi
-if [ ! -f "$CERC_REPO_BASE_DIR/container-output-dir/output-file" ]; then
+if [ ! -f "$container_output_dir/output-file" ]; then
     echo "deploy setup test: output file not present"
     echo "deploy setup test: FAILED"
     exit 1
 fi
-output_file_content=$(<$CERC_REPO_BASE_DIR/container-output-dir/output-file)
+output_file_content=$(<$container_output_dir/output-file)
 if [ ! "$output_file_content" == "output-data"  ]; then
     echo "deploy setup test: output file contents not correct"
     echo "deploy setup test: FAILED"
@@ -73,4 +74,49 @@ else
     exit 1
 fi
 $TEST_TARGET_SO --stack test deploy down --delete-volumes
+# Basic test of creating a deployment
+test_deployment_dir=$CERC_REPO_BASE_DIR/test-deployment-dir
+test_deployment_spec=$CERC_REPO_BASE_DIR/test-deployment-spec.yml
+$TEST_TARGET_SO --stack test deploy init --output $test_deployment_spec
+# Check the file now exists
+if [ ! -f "$test_deployment_spec" ]; then
+    echo "deploy init test: spec file not present"
+    echo "deploy init test: FAILED"
+    exit 1
+fi
+echo "deploy init test: passed"
+$TEST_TARGET_SO deploy create --spec-file $test_deployment_spec --deployment-dir $test_deployment_dir
+# Check the deployment dir exists
+if [ ! -d "$test_deployment_dir" ]; then
+    echo "deploy create test: deployment directory not present"
+    echo "deploy create test: FAILED"
+    exit 1
+fi
+echo "deploy create test: passed"
+# Check the file writted by the create command in the stack now exists
+if [ ! -f "$test_deployment_dir/create-file" ]; then
+    echo "deploy create test: create output file not present"
+    echo "deploy create test: FAILED"
+    exit 1
+fi
+# And has the right content
+create_file_content=$(<$test_deployment_dir/create-file)
+if [ ! "$create_file_content" == "create-command-output-data"  ]; then
+    echo "deploy create test: create output file contents not correct"
+    echo "deploy create test: FAILED"
+    exit 1
+fi
+echo "deploy create output file test: passed"
+# Try to start the deployment
+$TEST_TARGET_SO deployment --dir $test_deployment_dir start
+# Check logs command works
+log_output_2=$( $TEST_TARGET_SO deployment --dir $test_deployment_dir logs )
+if [[ "$log_output_2" == *"Filesystem is fresh"* ]]; then
+    echo "deployment logs test: passed"
+else
+    echo "deployment logs test: FAILED"
+    exit 1
+fi
+# Stop and clean up
+$TEST_TARGET_SO deployment --dir $test_deployment_dir stop --delete-volumes
 echo "Test passed"