blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Manager: ensure the {jobs} implicit variable uses forward slashes

Browse Source 
Since the variable expansion is unaware of path semantics, using forward
slashes is the safest way to go about things in a platform-indepdent way.
This commit is contained in:
Sybren A. Stüvel 2022-07-13 12:45:55 +02:00
parent ce250a611e
commit 3c290b1f6d
3 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
internal/manager/api_impl/varrepl_test.go
View File

@ -3,7 +3,7 @@ package api_impl
// SPDX-License-Identifier: GPL-3.0-or-later
import (
"path"
"runtime"
"testing"
"github.com/stretchr/testify/assert"
@ -11,6 +11,7 @@ import (
"git.blender.org/flamenco/internal/manager/config"
"git.blender.org/flamenco/internal/manager/persistence"
"git.blender.org/flamenco/pkg/api"
"git.blender.org/flamenco/pkg/crosspath"
)
func varreplTestTask() api.AssignedTask {
@ -106,25 +107,33 @@ func TestReplaceJobsVariable(t *testing.T) {
// An implicit variable "{jobs}" should be created, regardless of whether
// Shaman is enabled or not.
var storagePath string
switch runtime.GOOS {
case "windows":
storagePath = `C:\path\to\flamenco-storage`
default:
storagePath = "/path/to/flamenco-storage"
}
{ // Test with Shaman enabled.
conf := config.GetTestConfig(func(c *config.Conf) {
c.SharedStoragePath = "/path/to/flamenco-storage"
c.SharedStoragePath = storagePath
c.Shaman.Enabled = true
})
replacedTask := replaceTaskVariables(&conf, task, worker)
expectPath := path.Join(conf.Shaman.CheckoutPath(), "path/in/storage.blend")
expectPath := crosspath.Join(crosspath.ToSlash(conf.Shaman.CheckoutPath()), "path/in/storage.blend")
assert.Equal(t, expectPath, replacedTask.Commands[2].Parameters["filepath"])
}
{ // Test without Shaman.
conf := config.GetTestConfig(func(c *config.Conf) {
c.SharedStoragePath = "/path/to/flamenco-storage"
c.SharedStoragePath = storagePath
c.Shaman.Enabled = false
})
replacedTask := replaceTaskVariables(&conf, task, worker)
expectPath := "/path/to/flamenco-storage/jobs/path/in/storage.blend"
expectPath := crosspath.Join(storagePath, "jobs", "path/in/storage.blend")
assert.Equal(t, expectPath, replacedTask.Commands[2].Parameters["filepath"])
}
}

3
internal/manager/config/config.go
View File

@ -19,6 +19,7 @@ import (
yaml "gopkg.in/yaml.v2"
"git.blender.org/flamenco/internal/appinfo"
"git.blender.org/flamenco/pkg/crosspath"
shaman_config "git.blender.org/flamenco/pkg/shaman/config"
)
@ -271,7 +272,7 @@ func (c *Conf) addImplicitVariables() {
{
Audience: VariableAudienceAll,
Platform: VariablePlatformAll,
Value: c.EffectiveStoragePath(),
Value: crosspath.ToSlash(c.EffectiveStoragePath()),
},
},
}

9
internal/manager/config/settings_test.go
View File

@ -5,6 +5,7 @@ package config
import (
"testing"
"git.blender.org/flamenco/pkg/crosspath"
"github.com/stretchr/testify/assert"
)
@ -66,7 +67,9 @@ func TestStorageImplicitVariablesWithShaman(t *testing.T) {
t.FailNow()
}
assert.False(t, c.implicitVariables["jobs"].IsTwoWay)
assert.Equal(t, c.Shaman.CheckoutPath(), c.implicitVariables["jobs"].Values[0].Value)
assert.Equal(t,
crosspath.ToSlash(c.Shaman.CheckoutPath()),
c.implicitVariables["jobs"].Values[0].Value)
}
func TestStorageImplicitVariablesWithoutShaman(t *testing.T) {
@ -92,5 +95,7 @@ func TestStorageImplicitVariablesWithoutShaman(t *testing.T) {
t.FailNow()
}
assert.False(t, c.implicitVariables["jobs"].IsTwoWay)
assert.Equal(t, c.SharedStoragePath, c.implicitVariables["jobs"].Values[0].Value)
assert.Equal(t,
crosspath.ToSlash(c.SharedStoragePath),
c.implicitVariables["jobs"].Values[0].Value)
}