mirror of
https://github.com/coder/coder.git
synced 2025-07-15 22:20:27 +00:00
fix: fix coder template pull on Windows (#9327)
* fix: fix coder template pull on Windows Signed-off-by: Spike Curtis <spike@coder.com> * appease linter Signed-off-by: Spike Curtis <spike@coder.com> * improvements from code review Signed-off-by: Spike Curtis <spike@coder.com> --------- Signed-off-by: Spike Curtis <spike@coder.com>
This commit is contained in:
Spike Curtis
GitHub
@ -83,7 +83,7 @@ func (r *RootCmd) templatePull() *clibase.Cmd {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if dest == "" {
|
if dest == "" {
|
||||||
dest = templateName + "/"
|
dest = templateName
|
||||||
}
|
}
|
||||||
|
|
||||||
err = os.MkdirAll(dest, 0o750)
|
err = os.MkdirAll(dest, 0o750)
|
||||||
|
|||||||
@ -40,165 +40,218 @@ func dirSum(t *testing.T, dir string) string {
|
|||||||
return hex.EncodeToString(sum.Sum(nil))
|
return hex.EncodeToString(sum.Sum(nil))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTemplatePull(t *testing.T) {
|
func TestTemplatePull_NoName(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
t.Run("NoName", func(t *testing.T) {
|
inv, _ := clitest.New(t, "templates", "pull")
|
||||||
t.Parallel()
|
err := inv.Run()
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
inv, _ := clitest.New(t, "templates", "pull")
|
// Stdout tests that 'templates pull' pulls down the latest template
|
||||||
err := inv.Run()
|
// and writes it to stdout.
|
||||||
require.Error(t, err)
|
func TestTemplatePull_Stdout(t *testing.T) {
|
||||||
})
|
t.Parallel()
|
||||||
|
|
||||||
// Stdout tests that 'templates pull' pulls down the latest template
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
||||||
// and writes it to stdout.
|
user := coderdtest.CreateFirstUser(t, client)
|
||||||
t.Run("Stdout", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
// Create an initial template bundle.
|
||||||
user := coderdtest.CreateFirstUser(t, client)
|
source1 := genTemplateVersionSource()
|
||||||
|
// Create an updated template bundle. This will be used to ensure
|
||||||
|
// that templates are correctly returned in order from latest to oldest.
|
||||||
|
source2 := genTemplateVersionSource()
|
||||||
|
|
||||||
// Create an initial template bundle.
|
expected, err := echo.Tar(source2)
|
||||||
source1 := genTemplateVersionSource()
|
require.NoError(t, err)
|
||||||
// Create an updated template bundle. This will be used to ensure
|
|
||||||
// that templates are correctly returned in order from latest to oldest.
|
|
||||||
source2 := genTemplateVersionSource()
|
|
||||||
|
|
||||||
expected, err := echo.Tar(source2)
|
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
||||||
require.NoError(t, err)
|
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
||||||
|
|
||||||
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
||||||
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
|
||||||
|
|
||||||
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
// Update the template version so that we can assert that templates
|
||||||
|
// are being sorted correctly.
|
||||||
|
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
||||||
|
|
||||||
// Update the template version so that we can assert that templates
|
inv, root := clitest.New(t, "templates", "pull", "--tar", template.Name)
|
||||||
// are being sorted correctly.
|
clitest.SetupConfig(t, client, root)
|
||||||
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
|
||||||
|
|
||||||
inv, root := clitest.New(t, "templates", "pull", "--tar", template.Name)
|
var buf bytes.Buffer
|
||||||
clitest.SetupConfig(t, client, root)
|
inv.Stdout = &buf
|
||||||
|
|
||||||
var buf bytes.Buffer
|
err = inv.Run()
|
||||||
inv.Stdout = &buf
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = inv.Run()
|
require.True(t, bytes.Equal(expected, buf.Bytes()), "tar files differ")
|
||||||
require.NoError(t, err)
|
}
|
||||||
|
|
||||||
require.True(t, bytes.Equal(expected, buf.Bytes()), "tar files differ")
|
// ToDir tests that 'templates pull' pulls down the latest template
|
||||||
})
|
// and writes it to the correct directory.
|
||||||
|
func TestTemplatePull_ToDir(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
// ToDir tests that 'templates pull' pulls down the latest template
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
||||||
// and writes it to the correct directory.
|
user := coderdtest.CreateFirstUser(t, client)
|
||||||
t.Run("ToDir", func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
// Create an initial template bundle.
|
||||||
user := coderdtest.CreateFirstUser(t, client)
|
source1 := genTemplateVersionSource()
|
||||||
|
// Create an updated template bundle. This will be used to ensure
|
||||||
|
// that templates are correctly returned in order from latest to oldest.
|
||||||
|
source2 := genTemplateVersionSource()
|
||||||
|
|
||||||
// Create an initial template bundle.
|
expected, err := echo.Tar(source2)
|
||||||
source1 := genTemplateVersionSource()
|
require.NoError(t, err)
|
||||||
// Create an updated template bundle. This will be used to ensure
|
|
||||||
// that templates are correctly returned in order from latest to oldest.
|
|
||||||
source2 := genTemplateVersionSource()
|
|
||||||
|
|
||||||
expected, err := echo.Tar(source2)
|
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
||||||
require.NoError(t, err)
|
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
||||||
|
|
||||||
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
||||||
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
|
||||||
|
|
||||||
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
// Update the template version so that we can assert that templates
|
||||||
|
// are being sorted correctly.
|
||||||
|
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
||||||
|
|
||||||
// Update the template version so that we can assert that templates
|
dir := t.TempDir()
|
||||||
// are being sorted correctly.
|
|
||||||
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
expectedDest := filepath.Join(dir, "expected")
|
||||||
|
actualDest := filepath.Join(dir, "actual")
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
expectedDest := filepath.Join(dir, "expected")
|
err = extract.Tar(ctx, bytes.NewReader(expected), expectedDest, nil)
|
||||||
actualDest := filepath.Join(dir, "actual")
|
require.NoError(t, err)
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
err = extract.Tar(ctx, bytes.NewReader(expected), expectedDest, nil)
|
inv, root := clitest.New(t, "templates", "pull", template.Name, actualDest)
|
||||||
require.NoError(t, err)
|
clitest.SetupConfig(t, client, root)
|
||||||
|
|
||||||
inv, root := clitest.New(t, "templates", "pull", template.Name, actualDest)
|
ptytest.New(t).Attach(inv)
|
||||||
clitest.SetupConfig(t, client, root)
|
|
||||||
|
|
||||||
ptytest.New(t).Attach(inv)
|
require.NoError(t, inv.Run())
|
||||||
|
|
||||||
require.NoError(t, inv.Run())
|
require.Equal(t,
|
||||||
|
dirSum(t, expectedDest),
|
||||||
|
dirSum(t, actualDest),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
require.Equal(t,
|
// ToDir tests that 'templates pull' pulls down the latest template
|
||||||
dirSum(t, expectedDest),
|
// and writes it to a directory with the name of the template if the path is not implicitly supplied.
|
||||||
dirSum(t, actualDest),
|
// nolint: paralleltest
|
||||||
)
|
func TestTemplatePull_ToImplicit(t *testing.T) {
|
||||||
})
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
||||||
|
user := coderdtest.CreateFirstUser(t, client)
|
||||||
|
|
||||||
// FolderConflict tests that 'templates pull' fails when a folder with has
|
// Create an initial template bundle.
|
||||||
// existing
|
source1 := genTemplateVersionSource()
|
||||||
t.Run("FolderConflict", func(t *testing.T) {
|
// Create an updated template bundle. This will be used to ensure
|
||||||
t.Parallel()
|
// that templates are correctly returned in order from latest to oldest.
|
||||||
|
source2 := genTemplateVersionSource()
|
||||||
|
|
||||||
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
expected, err := echo.Tar(source2)
|
||||||
user := coderdtest.CreateFirstUser(t, client)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Create an initial template bundle.
|
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
||||||
source1 := genTemplateVersionSource()
|
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
||||||
// Create an updated template bundle. This will be used to ensure
|
|
||||||
// that templates are correctly returned in order from latest to oldest.
|
|
||||||
source2 := genTemplateVersionSource()
|
|
||||||
|
|
||||||
expected, err := echo.Tar(source2)
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
// Update the template version so that we can assert that templates
|
||||||
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
// are being sorted correctly.
|
||||||
|
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
||||||
|
|
||||||
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
// create a tempdir and change the working directory to it for the duration of the test (cannot run in parallel)
|
||||||
|
dir := t.TempDir()
|
||||||
|
wd, err := os.Getwd()
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = os.Chdir(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() {
|
||||||
|
err := os.Chdir(wd)
|
||||||
|
require.NoError(t, err, "if this fails, it can break other subsequent tests due to wrong working directory")
|
||||||
|
}()
|
||||||
|
|
||||||
// Update the template version so that we can assert that templates
|
expectedDest := filepath.Join(dir, "expected")
|
||||||
// are being sorted correctly.
|
actualDest := filepath.Join(dir, template.Name)
|
||||||
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
ctx := context.Background()
|
||||||
|
|
||||||
expectedDest := filepath.Join(dir, "expected")
|
err = extract.Tar(ctx, bytes.NewReader(expected), expectedDest, nil)
|
||||||
conflictDest := filepath.Join(dir, "conflict")
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = os.MkdirAll(conflictDest, 0o700)
|
inv, root := clitest.New(t, "templates", "pull", template.Name)
|
||||||
require.NoError(t, err)
|
clitest.SetupConfig(t, client, root)
|
||||||
|
|
||||||
err = os.WriteFile(
|
ptytest.New(t).Attach(inv)
|
||||||
filepath.Join(conflictDest, "conflict-file"),
|
|
||||||
[]byte("conflict"), 0o600,
|
|
||||||
)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
ctx := context.Background()
|
require.NoError(t, inv.Run())
|
||||||
|
|
||||||
err = extract.Tar(ctx, bytes.NewReader(expected), expectedDest, nil)
|
require.Equal(t,
|
||||||
require.NoError(t, err)
|
dirSum(t, expectedDest),
|
||||||
|
dirSum(t, actualDest),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
inv, root := clitest.New(t, "templates", "pull", template.Name, conflictDest)
|
// FolderConflict tests that 'templates pull' fails when a folder with has
|
||||||
clitest.SetupConfig(t, client, root)
|
// existing
|
||||||
|
func TestTemplatePull_FolderConflict(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
pty := ptytest.New(t).Attach(inv)
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
||||||
|
user := coderdtest.CreateFirstUser(t, client)
|
||||||
|
|
||||||
waiter := clitest.StartWithWaiter(t, inv)
|
// Create an initial template bundle.
|
||||||
|
source1 := genTemplateVersionSource()
|
||||||
|
// Create an updated template bundle. This will be used to ensure
|
||||||
|
// that templates are correctly returned in order from latest to oldest.
|
||||||
|
source2 := genTemplateVersionSource()
|
||||||
|
|
||||||
pty.ExpectMatch("not empty")
|
expected, err := echo.Tar(source2)
|
||||||
pty.WriteLine("no")
|
require.NoError(t, err)
|
||||||
|
|
||||||
waiter.RequireError()
|
version1 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, source1)
|
||||||
|
_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
|
||||||
|
|
||||||
ents, err := os.ReadDir(conflictDest)
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
require.Len(t, ents, 1, "conflict folder should have single conflict file")
|
// Update the template version so that we can assert that templates
|
||||||
})
|
// are being sorted correctly.
|
||||||
|
_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, source2, template.ID)
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
|
||||||
|
expectedDest := filepath.Join(dir, "expected")
|
||||||
|
conflictDest := filepath.Join(dir, "conflict")
|
||||||
|
|
||||||
|
err = os.MkdirAll(conflictDest, 0o700)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
err = os.WriteFile(
|
||||||
|
filepath.Join(conflictDest, "conflict-file"),
|
||||||
|
[]byte("conflict"), 0o600,
|
||||||
|
)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
err = extract.Tar(ctx, bytes.NewReader(expected), expectedDest, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
inv, root := clitest.New(t, "templates", "pull", template.Name, conflictDest)
|
||||||
|
clitest.SetupConfig(t, client, root)
|
||||||
|
|
||||||
|
pty := ptytest.New(t).Attach(inv)
|
||||||
|
|
||||||
|
waiter := clitest.StartWithWaiter(t, inv)
|
||||||
|
|
||||||
|
pty.ExpectMatch("not empty")
|
||||||
|
pty.WriteLine("no")
|
||||||
|
|
||||||
|
waiter.RequireError()
|
||||||
|
|
||||||
|
ents, err := os.ReadDir(conflictDest)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.Len(t, ents, 1, "conflict folder should have single conflict file")
|
||||||
}
|
}
|
||||||
|
|
||||||
// genTemplateVersionSource returns a unique bundle that can be used to create
|
// genTemplateVersionSource returns a unique bundle that can be used to create
|
||||||
|
|||||||
Reference in New Issue
Block a user