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

feat(file)!: snippets upload using SSH input stream #1085

Merged
merged 9 commits into from
Mar 3, 2024
Merged
Show file tree
Hide file tree
Changes from 7 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
6 changes: 5 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:

jobs:
build:
name: Build
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
Expand Down Expand Up @@ -40,6 +41,7 @@ jobs:
run: go vet . && go build -v .

test:
name: Unit Tests
needs: build
runs-on: ubuntu-latest
steps:
Expand Down Expand Up @@ -75,12 +77,14 @@ jobs:
run: make docs && git diff --exit-code

testacc:
if: "!contains(github.head_ref, 'renovate/')"
name: Dispatch Acceptance Tests
needs: build
runs-on: ubuntu-latest
steps:
- name: Invoke acceptance tests workflow
uses: benc-uk/workflow-dispatch@v1
with:
workflow: testacc.yml
ref: "main"
ref: ${{ github.event.pull_request.head.ref }}
inputs: '{"ref": "${{ github.head_ref }}" }'
3 changes: 1 addition & 2 deletions .github/workflows/testacc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ on:

jobs:
acceptance:
#refs/heads/renovate/tools
strategy:
max-parallel: 1
matrix:
os: [ ubuntu-latest ]
os: [ ubuntu-latest, windows-latest, macos-latest ]
terraform: [ 1.6 ]
runs-on: ${{ matrix.os }}
environment: pve-acc
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ You can configure the `sudo` privilege for the user via the command line on the
```sh
terraform ALL=(root) NOPASSWD: /sbin/pvesm
terraform ALL=(root) NOPASSWD: /sbin/qm
terraform ALL=(root) NOPASSWD: /usr/bin/mv /tmp/tfpve/* /var/lib/vz/*
terraform ALL=(root) NOPASSWD: /usr/bin/tee /var/lib/vz/*
```

Save the file and exit.
Expand Down
19 changes: 6 additions & 13 deletions fwprovider/tests/resource_file_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,12 @@ func uploadSnippetFile(t *testing.T, file *os.File) {
u, err := url.ParseRequestURI(endpoint)
require.NoError(t, err)

sshAgent := utils.GetAnyBoolEnv("PROXMOX_VE_SSH_AGENT")
sshUsername := utils.GetAnyStringEnv("PROXMOX_VE_SSH_USERNAME")
sshAgentSocket := utils.GetAnyStringEnv("SSH_AUTH_SOCK", "PROXMOX_VE_SSH_AUTH_SOCK", "PM_VE_SSH_AUTH_SOCK")
sshAgentSocket := utils.GetAnyStringEnv("SSH_AUTH_SOCK", "PROXMOX_VE_SSH_AUTH_SOCK")
sshPrivateKey := utils.GetAnyStringEnv("PROXMOX_VE_SSH_PRIVATE_KEY")
sshClient, err := ssh.NewClient(
sshUsername, "", true, sshAgentSocket, sshPrivateKey,
sshUsername, "", sshAgent, sshAgentSocket, sshPrivateKey,
"", "", "",
&nodeResolver{
node: ssh.ProxmoxNode{
Expand All @@ -146,21 +147,13 @@ func uploadSnippetFile(t *testing.T, file *os.File) {
defer f.Close()

fname := filepath.Base(file.Name())
err = sshClient.NodeUpload(context.Background(), "pve", "/tmp/tfpve/testacc",
err = sshClient.NodeStreamUpload(context.Background(), "pve", "/var/lib/vz/",
&api.FileUploadRequest{
ContentType: "snippets",
FileName: fname,
File: f,
})
require.NoError(t, err)

_, err = sshClient.ExecuteNodeCommands(context.Background(), "pve", []string{
fmt.Sprintf(`%s; try_sudo "mv /tmp/tfpve/testacc/snippets/%s /var/lib/vz/snippets/%s" && rm -rf /tmp/tfpve/testacc/`,
ssh.TrySudo,
fname, fname,
),
})
require.NoError(t, err)
}

func createFile(t *testing.T, namePattern string, content string) *os.File {
Expand Down Expand Up @@ -218,7 +211,7 @@ resource "proxmox_virtual_environment_file" "test" {
}
%s
}
`, getProviderConfig(t), accTestNodeName, fname, strings.Join(extra, "\n"))
`, getProviderConfig(t), accTestNodeName, strings.ReplaceAll(fname, `\`, `/`), strings.Join(extra, "\n"))
}

func testAccResourceFileTwoSourcesCreatedConfig(t *testing.T) string {
Expand Down Expand Up @@ -281,7 +274,7 @@ resource "proxmox_virtual_environment_file" "test" {
path = "%s"
}
}
`, getProviderConfig(t), accTestNodeName, fname)
`, getProviderConfig(t), accTestNodeName, strings.ReplaceAll(fname, `\`, `/`))
}

func testAccResourceFileSnippetUpdatedCheck(fname string) resource.TestCheckFunc {
Expand Down
110 changes: 110 additions & 0 deletions proxmox/ssh/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ type Client interface {
// NodeUpload uploads a file to a node.
NodeUpload(ctx context.Context, nodeName string,
remoteFileDir string, fileUploadRequest *api.FileUploadRequest) error

// NodeStreamUpload uploads a file to a node by streaming its content over SSH.
NodeStreamUpload(ctx context.Context, nodeName string,
remoteFileDir string, fileUploadRequest *api.FileUploadRequest) error
}

type client struct {
Expand Down Expand Up @@ -247,6 +251,112 @@ func (c *client) NodeUpload(
return nil
}

func (c *client) NodeStreamUpload(
ctx context.Context,
nodeName string,
remoteFileDir string,
d *api.FileUploadRequest,
) error {
ip, err := c.nodeResolver.Resolve(ctx, nodeName)
if err != nil {
return fmt.Errorf("failed to find node endpoint: %w", err)
}

tflog.Debug(ctx, "uploading file to the node datastore via SSH input stream ", map[string]interface{}{
"node_address": ip,
"remote_dir": remoteFileDir,
"file_name": d.FileName,
"content_type": d.ContentType,
})

fileInfo, err := d.File.Stat()
if err != nil {
return fmt.Errorf("failed to get file info: %w", err)
}

fileSize := fileInfo.Size()

sshClient, err := c.openNodeShell(ctx, ip)
if err != nil {
return fmt.Errorf("failed to open SSH client: %w", err)
}

defer func(sshClient *ssh.Client) {
e := sshClient.Close()
if e != nil {
tflog.Error(ctx, "failed to close SSH client", map[string]interface{}{
"error": e,
})
}
}(sshClient)

if d.ContentType != "" {
remoteFileDir = filepath.Join(remoteFileDir, d.ContentType)
}

remoteFilePath := strings.ReplaceAll(filepath.Join(remoteFileDir, d.FileName), `\`, "/")

sshSession, err := sshClient.NewSession()
if err != nil {
return fmt.Errorf("failed to create SSH session: %w", err)
}

defer func(session *ssh.Session) {
e := session.Close()
if e != nil {
tflog.Error(ctx, "failed to close SSH session", map[string]interface{}{
"error": e,
})
}
}(sshSession)

sshSession.Stdin = d.File

output, err := sshSession.CombinedOutput(
fmt.Sprintf(`%s; try_sudo "/usr/bin/tee %s"`, TrySudo, remoteFilePath),
)
if err != nil {
return fmt.Errorf("error transferring file: %s", string(output))
}

sftpClient, err := sftp.NewClient(sshClient)
if err != nil {
return fmt.Errorf("failed to create SFTP client: %w", err)
}

defer func(sftpClient *sftp.Client) {
e := sftpClient.Close()
if e != nil {
tflog.Error(ctx, "failed to close SFTP client", map[string]interface{}{
"error": e,
})
}
}(sftpClient)

remoteFile, err := sftpClient.Open(remoteFilePath)
if err != nil {
return fmt.Errorf("failed to open remote file %s: %w", remoteFilePath, err)
}

remoteStat, err := remoteFile.Stat()
if err != nil {
return fmt.Errorf("failed to read remote file %s: %w", remoteFilePath, err)
}

bytesUploaded := remoteStat.Size()
if bytesUploaded != fileSize {
return fmt.Errorf("failed to upload file %s: uploaded %d bytes, expected %d bytes",
remoteFilePath, bytesUploaded, fileSize)
}

tflog.Debug(ctx, "uploaded file to datastore", map[string]interface{}{
"remote_file_path": remoteFilePath,
"size": bytesUploaded,
})

return nil
}

// openNodeShell establishes a new SSH connection to a node.
func (c *client) openNodeShell(ctx context.Context, node ProxmoxNode) (*ssh.Client, error) {
homeDir, err := os.UserHomeDir()
Expand Down
26 changes: 1 addition & 25 deletions proxmoxtf/resource/file.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"strings"
"time"

"github.com/google/uuid"
"github.com/hashicorp/go-cty/cty"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
Expand Down Expand Up @@ -573,35 +572,12 @@ func fileCreate(ctx context.Context, d *schema.ResourceData, m interface{}) diag
}...)
}

// the temp directory is used to store the file on the node before moving it to the datastore
// will be created if it does not exist
tempFileDir := fmt.Sprintf("/tmp/tfpve/%s", uuid.NewString())

err = capi.SSH().NodeUpload(ctx, nodeName, tempFileDir, request)
err = capi.SSH().NodeStreamUpload(ctx, nodeName, *datastore.Path, request)
if err != nil {
diags = append(diags, diag.FromErr(err)...)
return diags
}

// handle the case where the file is uploaded to a subdirectory of the datastore
srcDir := tempFileDir
dstDir := *datastore.Path

if request.ContentType != "" {
srcDir = tempFileDir + "/" + request.ContentType
dstDir = *datastore.Path + "/" + request.ContentType
}

_, err := capi.SSH().ExecuteNodeCommands(ctx, nodeName, []string{
// the `mv` command should be scoped to the specific directories in sudoers!
fmt.Sprintf(`%s; try_sudo "mv %s/%s %s/%s" && rmdir %s && rmdir %s || echo`,
ssh.TrySudo,
srcDir, *fileName,
dstDir, *fileName,
srcDir,
tempFileDir,
),
})
if err != nil {
if matches, e := regexp.MatchString(`cannot move .* Permission denied`, err.Error()); e == nil && matches {
return diag.FromErr(ssh.NewErrUserHasNoPermission(capi.SSH().Username()))
Expand Down
Loading