Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print logs in post step for localnet action #10

Merged
merged 1 commit into from
Jun 23, 2024
Merged

Print logs in post step for localnet action #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions run-local-testnet/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,21 @@ inputs:
runs:
using: composite
steps:
# There is no way to configure post-if with this, so we just always print the logs
# in the post step.
- name: Set up printing logs in a post step
uses: aptos-labs/actions/with-post-step@main
with:
main: echo 'Configured post step to print logs at the end...'
post: |
echo "Printing logs from the localnet..."
if [ -n "${{ inputs.CLI_GIT_REF }}" ]; then
docker logs "local-testnet-${{ inputs.CLI_GIT_REF }}"
else
cat "${{ runner.temp }}/local-testnet-logs.txt"
fi
echo "Printed all logs from the localnet."

# Install node.
- uses: actions/setup-node@v4
with:
Expand Down Expand Up @@ -81,17 +96,3 @@ runs:
# Wait for the local testnet to start up.
- run: wait-on --verbose --interval 1500 --timeout 120000 --httpTimeout 120000 http-get://127.0.0.1:8070
shell: bash

# Print the logs from the local testnet if the tests failed.
- name: Print local testnet logs if something failed
run: docker logs local-testnet-${{ inputs.IMAGE_TAG }}
shell: bash
if: ${{ inputs.CLI_GIT_REF && failure() }}

# Print the logs from the local testnet if the tests failed.
- name: Print local testnet logs if something failed
run: cat ${{ runner.temp }}/local-testnet-logs.txt
shell: bash
if: ${{ !inputs.CLI_GIT_REF && failure() }}


23 changes: 23 additions & 0 deletions with-post-step/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Description

Generic JS Action to execute a main command and set a command as a post step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy the important links here too for context:
e.g. actions/runner#1478 and https://github.com/pyTooling/Actions/tree/main/with-post-step


Learn more about why we need this here: https://github.com/actions/runner/issues/1478

Originally forked from https://github.com/pyTooling/Actions/tree/main/with-post-step.


## Inputs

| parameter | description | required | default |
| --- | --- | --- | --- |
| main | Main command/script. | `true` | |
| post | Post command/script. | `true` | |
| key | Name of the state variable used to detect the post step. | `false` | POST |


## Runs

This action is a `node20` action.


54 changes: 54 additions & 0 deletions with-post-step/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# Unai Martinez-Corral #
# #
# ==================================================================================================================== #
# Copyright 2020-2024 The pyTooling Authors #
# #
# 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. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #

# Copied from: https://github.com/pyTooling/Actions/blob/main/with-post-step/action.yml

# Unfortunately composite actions don't support running regular old commands as a post
# step, so you need this hack. Learn more here:
# https://dev.to/abiwinanda/github-action-adding-post-steps-in-composite-actions-5ak3

name: With post step

description: |
Generic JS Action to execute a main command and set a command as a post step.

Learn more about why we need this here: https://github.com/actions/runner/issues/1478

Originally forked from https://github.com/pyTooling/Actions/tree/main/with-post-step.

inputs:
main:
description: "Main command/script."
required: true
post:
description: "Post command/script."
required: true
key:
description: "Name of the state variable used to detect the post step."
required: false
default: POST

runs:
using: "node20"
main: "main.js"
post: "main.js"
52 changes: 52 additions & 0 deletions with-post-step/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/* ================================================================================================================== *
* Authors: *
* Unai Martinez-Corral *
* *
* ================================================================================================================== *
* Copyright 2021-2022 Unai Martinez-Corral <[email protected]> *
* Copyright 2022 Unai Martinez-Corral <[email protected]> *
* *
* 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. *
* *
* SPDX-License-Identifier: Apache-2.0 *
* ================================================================================================================== *
* *
* Context: *
* * https://github.com/docker/login-action/issues/72 *
* * https://github.com/actions/runner/issues/1478 *
* ================================================================================================================== *
*/

// Copied from: https://github.com/pyTooling/Actions/blob/main/with-post-step/main.js

// See action.yaml for an explanation for why we have this.

const { spawn } = require("child_process");
const { appendFileSync } = require("fs");
const { EOL } = require("os");

function run(cmd) {
const subprocess = spawn(cmd, { stdio: "inherit", shell: true });
subprocess.on("exit", (exitCode) => {
process.exitCode = exitCode;
});
}

const key = process.env.INPUT_KEY.toUpperCase();

if ( process.env[`STATE_${key}`] !== undefined ) { // Are we in the 'post' step?
run(process.env.INPUT_POST);
} else { // Otherwise, this is the main step
appendFileSync(process.env.GITHUB_STATE, `${key}=true${EOL}`);
run(process.env.INPUT_MAIN);
}
Loading