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.

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

Permissions setting in action to read git repo #69

Merged
merged 4 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 12 additions & 7 deletions src/main.sh
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,16 @@ function comment {

function setup_git {
# Avoid git permissions warnings
sudo git config --global --add safe.directory /github/workspace
git config --global --add safe.directory /github/workspace
# Also trust any subfolder within workspace
sudo git config --global --add safe.directory "*"
git config --global --add safe.directory "*"
}

function setup_permissions {
local -r dir="${1}"
# fetch the user id and group id under which the github action is running
local -r uid=$(stat -c "%u" "/github/workspace")
local -r gid=$(stat -c "%g" "/github/workspace")
local -r uid="${2}"
local -r gid="${3}"

if [[ -e "${dir}" ]]; then
sudo chown -R "$uid:$gid" "${dir}"
sudo chmod -R o+rw "${dir}"
Expand Down Expand Up @@ -173,8 +173,13 @@ function main {
exit 1
fi
setup_git
setup_permissions "${tg_dir}"
trap 'setup_permissions $tg_dir ' EXIT
# fetch the user id and group id under which the github action is running
local -r uid=$(stat -c "%u" "/github/workspace")
local -r gid=$(stat -c "%g" "/github/workspace")
local -r action_user=$(whoami)

setup_permissions "${tg_dir}" "${action_user}" "${action_user}"
trap 'setup_permissions $tg_dir $uid $guid' EXIT
setup_pre_exec

if [[ -n "${tf_version}" ]]; then
Expand Down
46 changes: 40 additions & 6 deletions test/action_run_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ package test
import (
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"

"github.com/gruntwork-io/terratest/modules/random"
Expand All @@ -28,8 +30,11 @@ func TestTerragruntAction(t *testing.T) {
buildImage(t, "ssh-agent:local", "ssh-agent")

testCases := []ActionConfig{
{"Terraform", "TF", "1.4.6", "0.46.3"},
{"OpenTofu", "TOFU", "1.6.0", "0.53.3"},
{"Terraform1.5", "TF", "1.5.7", "0.55.18"},
{"Terraform1.7", "TF", "1.7.5", "0.55.18"},
{"Terraform1.8", "TF", "1.8.3", "0.55.18"},
{"OpenTofu1.6", "TOFU", "1.6.0", "0.55.18"},
{"OpenTofu1.7", "TOFU", "1.7.0", "0.55.18"},
}

for _, tc := range testCases {
Expand All @@ -49,6 +54,10 @@ func TestTerragruntAction(t *testing.T) {
t.Parallel()
testOutputPlanIsUsedInApply(t, tc, tag)
})
t.Run("testGitWorkingAction", func(t *testing.T) {
t.Parallel()
testGitWorkingAction(t, tc, tag)
})
t.Run("testRunAllIsExecute", func(t *testing.T) {
t.Parallel()
testRunAllIsExecuted(t, tc, tag)
Expand All @@ -65,26 +74,40 @@ func testActionIsExecuted(t *testing.T, actionConfig ActionConfig, tag string) {
fixturePath := prepareFixture(t, "fixture-action-execution")

outputTF := runAction(t, actionConfig, false, tag, fixturePath, "plan")
assert.Contains(t, outputTF, "You can apply this plan to save these new output values to the "+actionConfig.iacName)
assert.Contains(t, outputTF, "You can apply this plan to save these new output values to the "+fetchIacType(actionConfig))
}

func testActionIsExecutedSSHProject(t *testing.T, actionConfig ActionConfig, tag string) {
fixturePath := prepareFixture(t, "fixture-action-execution-ssh")

outputTF := runAction(t, actionConfig, true, tag, fixturePath, "plan")
assert.Contains(t, outputTF, "You can apply this plan to save these new output values to the "+actionConfig.iacName)
assert.Contains(t, outputTF, "You can apply this plan to save these new output values to the "+fetchIacType(actionConfig))
}

func testOutputPlanIsUsedInApply(t *testing.T, actionConfig ActionConfig, tag string) {
fixturePath := prepareFixture(t, "fixture-dependencies-project")

output := runAction(t, actionConfig, false, tag, fixturePath, "run-all plan -out=plan.out")
output := runAction(t, actionConfig, false, tag, fixturePath, "run-all plan -out=plan.out --terragrunt-log-level debug")
assert.Contains(t, output, "1 to add, 0 to change, 0 to destroy", actionConfig.iacName)

output = runAction(t, actionConfig, false, tag, fixturePath, "run-all apply plan.out")
output = runAction(t, actionConfig, false, tag, fixturePath, "run-all apply plan.out --terragrunt-log-level debug")
assert.Contains(t, output, "1 added, 0 changed, 0 destroyed", actionConfig.iacName)
}

func testGitWorkingAction(t *testing.T, actionConfig ActionConfig, tag string) {
fixturePath := prepareFixture(t, "fixture-git-commands")
// init git repo in fixture path, run git init
_, err := exec.Command("git", "init", fixturePath).CombinedOutput()
if err != nil {
t.Fatalf("Error initializing git repo: %v", err)
}

output := runAction(t, actionConfig, true, tag, fixturePath, "run-all plan -out=plan.out --terragrunt-log-level debug")
assert.Contains(t, output, fetchIacType(actionConfig)+" has been successfully initialized!", actionConfig.iacName)
assert.Contains(t, output, "execute_INPUT_POST_EXEC_1", actionConfig.iacName)
assert.Contains(t, output, "execute_INPUT_PRE_EXEC_1", actionConfig.iacName)
}

func testRunAllIsExecuted(t *testing.T, actionConfig ActionConfig, tag string) {
fixturePath := prepareFixture(t, "fixture-dependencies-project")

Expand Down Expand Up @@ -129,6 +152,8 @@ func runAction(t *testing.T, actionConfig ActionConfig, sshAgent bool, tag, fixt
"INPUT_TG_VERSION=" + actionConfig.tgVersion,
"INPUT_TG_COMMAND=" + command,
"INPUT_TG_DIR=/github/workspace",
"INPUT_PRE_EXEC_1=echo 'execute_INPUT_PRE_EXEC_1'",
"INPUT_POST_EXEC_1=echo 'execute_INPUT_POST_EXEC_1'",
fmt.Sprintf("GITHUB_OUTPUT=/tmp/github-action-logs.%d", logId),
},
Volumes: []string{
Expand Down Expand Up @@ -167,3 +192,12 @@ func prepareFixture(t *testing.T, fixtureDir string) string {
require.NoError(t, err)
return path
}

func fetchIacType(actionConfig ActionConfig) string {
// return Terraform if OpenTofu based on iacName value
if strings.ToLower(actionConfig.iacType) == "tf" {
return "Terraform"
}
return "OpenTofu"

}
12 changes: 12 additions & 0 deletions test/fixture-git-commands/terragrunt.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
terraform {
source = "git@github.com:gruntwork-io/terragrunt.git//test/fixture-download/hello-world?ref=v0.9.9"
}

locals {
get_path_to_repo_root = get_path_to_repo_root()
get_path_from_repo_root = get_path_from_repo_root()
}

inputs = {
name = "Test git commands"
}