`//go:embed <path to file in parent directory>` doesn't work #46056

gucio321 · 2021-05-08T18:44:41Z

What version of Go are you using (`go version`)?

go version go1.16.4 linux/amd64

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (`go env`)?

go env Output

GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/user/.cache/go-build"
GOENV="/home/user/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/user/go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/user/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.16.4"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/dev/null"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build3225948580=/tmp/go-build -gno-record-gcc-switches"

What did you do?

There is a following package:

main.go
README.md
assets:
- assets.go

assets.go contains package assets loaded with //go:embed directive.
I'd like to add README.md file to assets.go, but //go:embed ../README.md doesn't work

What did you expect to see?

the program should compile and work fine.

What did you see instead?

assets/assets.go:59:12: pattern ../README.md: invalid pattern syntax

The text was updated successfully, but these errors were encountered:

seankhliao · 2021-05-08T20:12:49Z

This is intentional and documnted

Patterns may not contain ‘.’ or ‘..’ or empty path elements, nor may they begin or end with a slash.

gucio321 · 2021-05-16T10:37:03Z

@seankhliao is it possible to make it a feature request?

seankhliao · 2021-05-16T10:55:46Z

It still can't cross module boundaries, and if it's in the same module you can just put the embed directive in a go file in the parent directory

gucio321 · 2021-05-21T09:30:22Z

yah, this solution is possible, but it would be a bit crazy.
I'd need to add go:embed directive in main.go and pass on embeded variable to my app? it doesn't seem right.

gucio321 · 2021-05-21T09:31:40Z

@seankhliao maybe go:embed in module area could be allowed?

seankhliao · 2021-05-21T13:16:49Z

This was an explicit design decision:

Because embed.Files implements fs.FS, it cannot provide access to files with names beginning with .., so files in parent directories are also disallowed entirely, even when the parent directory named by .. does happen to be in the same module.

ref: https://go.googlesource.com/proposal/+/master/design/draft-embed.md

To start using the new ✨ [embed pkg](https://pkg.go.dev/embed) and deprecate our use of packr we need to move all of our templates under the `internal/pkg/template` pkg. This is because unfortunately we can't refer to the current "templates" directory by doing `"../../../templates"`: > Because embed.Files implements fs.FS, it cannot provide access to files with names beginning with .., so files in parent directories are also disallowed entirely, even when the parent directory named by .. does happen to be in the same module. > > golang/go#46056 (comment) By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

…#2691) To start using the new ✨ [embed pkg](https://pkg.go.dev/embed) and deprecate our use of packr we need to move all of our templates under the `internal/pkg/template` pkg. This is because unfortunately we can't refer to the current "templates" directory by doing `"../../../templates"`: > Because embed.Files implements fs.FS, it cannot provide access to files with names beginning with .., so files in parent directories are also disallowed entirely, even when the parent directory named by .. does happen to be in the same module. > > golang/go#46056 (comment) By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

* Removed installing go genesis. * Removed the existing genesis file handler. * Changed to go embed for file serving. * Updated envsetup.sh to generate frontend within assets package. * Had to generate within assets package because go embed does not support path traversing golang/go#46056

lonnyzhang423 · 2021-09-13T08:13:56Z

It still can't cross module boundaries, and if it's in the same module you can just put the embed directive in a go file in the parent directory

@gucio321 There is no need to put embed files into child directories, * can be used to match everything int the current directory.

I found this in embed draft.
https://go.googlesource.com/proposal/+/master/design/draft-embed.md#go_embed-directives

purpleidea · 2021-09-27T07:34:14Z

There's a major bug with this:

I have the COPYING license file in my project root. But my CLI package which wants to display that text is in a subdir. And so I can't ../COPYING to embed it. I don't think you should be able to get out of the package root, but this blocks the obvious use case that we used go-bindata for :/

korya · 2021-10-08T00:41:36Z

I agree. It makes sense to limit go:embed access to the whole directory of the current module rather than the current directory. One should be able to embed files within the whole "sub-tree" of the root directory of the current module. Right now, I end up applying the following pattern:

//go:generate cp -r ../../assets ./local-asset-dir
//go:embed local-asset-dir
var assetFs embed.FS

This works but it looks bad and I would like to avoid it.

sam-hoffman · 2021-10-20T21:47:24Z

@korya , does your solution work to embed one file into a slice of bytes?

gucio321 · 2021-10-21T14:23:12Z

@korya what do you mean by go:generate ../../assets ./local-asset-dir?
is assets some executable or just file/directory?

korya · 2021-10-21T15:04:51Z

@korya , does your solution work to embed one file into a slice of bytes?

It should work.

@korya what do you mean by go:generate ../../assets ./local-asset-dir?

Sorry, there is a typo. I missed cp -r. It should be //go:generate cp -r ../../assets ./local-asset-dir. I've fixed my original post.

gucio321 · 2021-10-21T15:29:13Z

hmm, right, it may work, but it will not be portable :-(.
I don't remember, how will it work on windows, but ln -s could probably be used.

gunsluo · 2021-10-26T08:15:22Z

I have the same issue, go:generate ../../assets ./local-asset-dir doesn't look good

JuanigTorres · 2022-01-03T12:29:34Z

Wouldn't it be nice if embed could support predefined variables like 'dirname' or 'projectname' to avoid some unexpected bug and thus avoid the '..' or '.'?

gucio321 · 2022-01-04T10:57:41Z

it sounds nice!
Maybe we should make a new issue @JuanigTorres ?

JuanigTorres · 2022-01-04T12:20:22Z

Sounds good to me!

AlexeyInc · 2022-04-22T22:21:22Z

it sounds nice! Maybe we should make a new issue @JuanigTorres ?

If it's still relevant I found good answer here.

@alecthomas

We remove the `--schema` flag from the `gen-installer` command, for it's no longer perceived to be useful. We move the tempate file `install.sh.tmpl` to the `files/` directory for consistency. Due to a golang constraint (cf. golang/go#46056), we created a package `files` to make the installer template available to other packages. Thank @alecthomas and @jvmakine for their feedback.

Add hermit gen-installer subcommand. It prints the SHA-256 digest of the generated installer script to stdout. We also perform a cross-check in CI to make sure `cmd/geninstaller` and `hermit gen-installer` produce identical installer scripts. We remove the `--schema` flag from the `gen-installer` command, for it's no longer perceived to be useful. We move the tempate file `install.sh.tmpl` to the `files/` directory for consistency. Due to a golang constraint (cf. golang/go#46056), we created a package `files` to make the installer template available to other packages.

BapiGso · 2022-12-06T13:37:28Z

maybe do this，Create a new assets.go in the directory that needs to be packaged

package assets

import "embed"

//go:embed *
var Assets embed.FS

Then use this variable in another package

a :=&assets.Assets

…#2691) To start using the new ✨ [embed pkg](https://pkg.go.dev/embed) and deprecate our use of packr we need to move all of our templates under the `internal/pkg/template` pkg. This is because unfortunately we can't refer to the current "templates" directory by doing `"../../../templates"`: > Because embed.Files implements fs.FS, it cannot provide access to files with names beginning with .., so files in parent directories are also disallowed entirely, even when the parent directory named by .. does happen to be in the same module. > > golang/go#46056 (comment) By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

KernelDeimos · 2023-02-12T18:01:55Z

I want my webpack bundle to go in a different folder than the golang source code. I want to have a build folder that's .gitignored in the root of my repository so it's easy to keep track of transient files vs persistent ones. The fact that go:embed won't let me do this is arbitrary and stupid. Just let me specify a "target folder" in the virtual (embedded) filesystem instead of assuming I want to copy the file structure relative to my source file (which I almost never want to do as it is)

gucio321 · 2023-02-12T19:21:39Z

I think, we needs to "construct" a proposal issue to solve this problem.
Here is what I think:
I understand maintainers' point of view

Because embed.Files implements fs.FS, it cannot provide access to files with names beginning with .., so files in parent directories are also disallowed entirely, even when the parent directory named by .. does happen to be in the same module.

In my opinion its not a good justification - it sounds like saying "we can't add this, since it is not implemented"

It still can't cross module boundaries, and if it's in the same module you can just put the embed directive in a go file in the parent directory

First of all let me note that putting go:embed directive in a parent directory does not look good at all. Over that, it may cause "cyclic import error" (or anyhow it is called in go - cant remember exacltly).
I agree that crossing module boundries wouldn't be good.
However, in my opinion, "shouldn't cross module boundries" does not equal "could not reffer to parent directory" - thats the point here. I think that compiler should accept .. pattern and should compile successfully as long as go:embed doesn't reffer to file above go.mod's location.

Any thoughts?

seankhliao · 2023-02-12T19:29:31Z

As mentioned before, not having .. isn't that it's just not implemented, it goes against the contract specified by io/fs.FS.

gucio321 · 2023-02-12T19:43:33Z

As mentioned before, not having .. isn't that it's just not implemented, it goes against the contract specified by io/fs.FS.

well, but go:embed does not need to use fs.FS in fact, does it? Maybe embed.FS should implement fs.FS, but in some extended form so that it could support .. pattern?

tigerinus · 2023-03-05T15:26:35Z

The best practice here is to create a package in parent level with go:embed var in there; then reference to this var in the child level packages.

seankhliao closed this as completed May 8, 2021

efekarakus mentioned this issue Aug 3, 2021

refactor: move "templates" pkg under "internal/pkg/template" pkg aws/copilot-cli#2691

Merged

nathannaveen mentioned this issue Sep 4, 2021

Used Go embed instead of genesis simpleiot/simpleiot#261

Closed

aschmahmann mentioned this issue Jan 3, 2022

feat: codegen go-bindnode support ipld/go-ipldtool#3

Merged

yanivagman mentioned this issue Feb 16, 2022

Finish tracee repo restructure aquasecurity/tracee#1460

Merged

iyear mentioned this issue May 26, 2022

🍀 Proposal: Use embed to read the default config devstream-io/devstream#603

Closed

rmehta19 mentioned this issue May 27, 2022

Static TLS Configuration Store Library Implementation google/s2a-go#18

Merged

jeniawhite mentioned this issue Jun 13, 2022

Refactor bundle building flow elastic/csp-security-policies#102

Merged

gregLibert mentioned this issue Sep 5, 2022

[BACK] - Replace the file generator textFileToGoConst massalabs/station#70

Closed

lucian-ioan mentioned this issue Nov 4, 2022

Provide custom template support for render elastic/elastic-agent-changelog-tool#118

Merged

yk-eukarya mentioned this issue Jan 23, 2023

feat(server): i18n for error messages reearth/reearth-cms#601

Merged

2opremio mentioned this issue Feb 7, 2023

internal/integration: update the soroban tests for auth next support stellar/go#4759

Merged

7 tasks

This was referenced Feb 14, 2023

proposal: embed: allow embeding files in a parent directory #58519

Closed

proposal: embed: treat / as module's root in go:embed directive #58525

Closed

00z20 mentioned this issue Feb 14, 2023

> Consider the following code: #58526

Closed

This comment was marked as spam.

Sign in to view

golang locked as resolved and limited conversation to collaborators Mar 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`//go:embed <path to file in parent directory>` doesn't work #46056

`//go:embed <path to file in parent directory>` doesn't work #46056

gucio321 commented May 8, 2021

seankhliao commented May 8, 2021

gucio321 commented May 16, 2021

seankhliao commented May 16, 2021

gucio321 commented May 21, 2021

gucio321 commented May 21, 2021

seankhliao commented May 21, 2021

lonnyzhang423 commented Sep 13, 2021

purpleidea commented Sep 27, 2021

korya commented Oct 8, 2021 •

edited

Loading

sam-hoffman commented Oct 20, 2021

gucio321 commented Oct 21, 2021

korya commented Oct 21, 2021

gucio321 commented Oct 21, 2021 •

edited

Loading

gunsluo commented Oct 26, 2021

JuanigTorres commented Jan 3, 2022 •

edited

Loading

gucio321 commented Jan 4, 2022

JuanigTorres commented Jan 4, 2022

AlexeyInc commented Apr 22, 2022

BapiGso commented Dec 6, 2022

KernelDeimos commented Feb 12, 2023

gucio321 commented Feb 12, 2023 •

edited

Loading

seankhliao commented Feb 12, 2023

gucio321 commented Feb 12, 2023

tigerinus commented Mar 5, 2023

This comment was marked as spam.

//go:embed <path to file in parent directory> doesn't work #46056

//go:embed <path to file in parent directory> doesn't work #46056

Comments

gucio321 commented May 8, 2021

What version of Go are you using (go version)?

Does this issue reproduce with the latest release?

What operating system and processor architecture are you using (go env)?

What did you do?

What did you expect to see?

What did you see instead?

seankhliao commented May 8, 2021

gucio321 commented May 16, 2021

seankhliao commented May 16, 2021

gucio321 commented May 21, 2021

gucio321 commented May 21, 2021

seankhliao commented May 21, 2021

lonnyzhang423 commented Sep 13, 2021

purpleidea commented Sep 27, 2021

korya commented Oct 8, 2021 • edited Loading

sam-hoffman commented Oct 20, 2021

gucio321 commented Oct 21, 2021

korya commented Oct 21, 2021

gucio321 commented Oct 21, 2021 • edited Loading

gunsluo commented Oct 26, 2021

JuanigTorres commented Jan 3, 2022 • edited Loading

gucio321 commented Jan 4, 2022

JuanigTorres commented Jan 4, 2022

AlexeyInc commented Apr 22, 2022

BapiGso commented Dec 6, 2022

KernelDeimos commented Feb 12, 2023

gucio321 commented Feb 12, 2023 • edited Loading

seankhliao commented Feb 12, 2023

gucio321 commented Feb 12, 2023

tigerinus commented Mar 5, 2023

This comment was marked as spam.

`//go:embed <path to file in parent directory>` doesn't work #46056

`//go:embed <path to file in parent directory>` doesn't work #46056

What version of Go are you using (`go version`)?

What operating system and processor architecture are you using (`go env`)?

korya commented Oct 8, 2021 •

edited

Loading

gucio321 commented Oct 21, 2021 •

edited

Loading

JuanigTorres commented Jan 3, 2022 •

edited

Loading

gucio321 commented Feb 12, 2023 •

edited

Loading