Skip to content

Output relative paths for migrate code template references #330

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 24, 2024
Merged

Output relative paths for migrate code template references #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
722f415
Output relative paths for code template references
SBGoods Jan 24, 2024
8b5fb16
Add Changelog entry
SBGoods Jan 24, 2024
02afb0e
Merge branch 'main' into SBGoods/migrate-relative-paths
SBGoods Jan 24, 2024
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: 6 additions & 0 deletions .changes/unreleased/BUG FIXES-20240124-131519.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: BUG FIXES
body: 'migrate: use relative paths (from provider directory) instead of absolute paths
for migrated code templates'
time: 2024-01-24T13:15:19.830885-05:00
custom:
Issue: "330"
32 changes: 16 additions & 16 deletions ...fplugindocs/testdata/scripts/schema-json/migrate/time_provider_success_docs_website.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ These resources provide an optional map argument called `triggers` that can be p

For example:

{{tffile "$WORK/examples/example_1.tf"}}
{{tffile "examples/example_1.tf"}}

`triggers` are *not* treated as sensitive attributes; a value used for `triggers` will be displayed in Terraform UI output as plaintext.

Expand All @@ -713,7 +713,7 @@ Given an RFC3339 timestamp string, will parse and return an object representatio

## Example Usage

{{tffile "$WORK/examples/functions/rfc3339_parse/example_1.tf"}}
{{tffile "examples/functions/rfc3339_parse/example_1.tf"}}

## Signature

Expand Down Expand Up @@ -745,11 +745,11 @@ Manages an offset time resource, which keeps an UTC timestamp stored in the Terr

### Basic Usage

{{tffile "$WORK/examples/resources/offset/example_1.tf"}}
{{tffile "examples/resources/offset/example_1.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/offset/example_2.tf"}}
{{tffile "examples/resources/offset/example_2.tf"}}

## Argument Reference

Expand Down Expand Up @@ -784,7 +784,7 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the base UTC RFC3339 timestamp and offset years, months, days, hours, minutes, and seconds, separated by commas (`,`), e.g.

{{codefile "shell" "$WORK/examples/resources/offset/import_1.sh"}}
{{codefile "shell" "examples/resources/offset/import_1.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/rotating.md.tmpl --
Expand All @@ -808,7 +808,7 @@ Manages a rotating time resource, which keeps a rotating UTC timestamp stored in

This example configuration will rotate (destroy/create) the resource every 30 days.

{{tffile "$WORK/examples/resources/rotating/example_1.tf"}}
{{tffile "examples/resources/rotating/example_1.tf"}}

## Argument Reference

Expand Down Expand Up @@ -842,11 +842,11 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the base UTC RFC3339 value and rotation years, months, days, hours, and minutes, separated by commas (`,`), e.g. for 30 days

{{codefile "shell" "$WORK/examples/resources/rotating/import_1.sh"}}
{{codefile "shell" "examples/resources/rotating/import_1.sh"}}

Otherwise, to import with the rotation RFC3339 value, the base UTC RFC3339 value and rotation UTC RFC3339 value, separated by commas (`,`), e.g.

{{codefile "shell" "$WORK/examples/resources/rotating/import_2.sh"}}
{{codefile "shell" "examples/resources/rotating/import_2.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/sleep.md.tmpl --
Expand All @@ -870,15 +870,15 @@ Manages a resource that delays creation and/or destruction, typically for furthe

### Delay Create Usage

{{tffile "$WORK/examples/resources/sleep/example_1.tf"}}
{{tffile "examples/resources/sleep/example_1.tf"}}

### Delay Destroy Usage

{{tffile "$WORK/examples/resources/sleep/example_2.tf"}}
{{tffile "examples/resources/sleep/example_2.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/sleep/example_3.tf"}}
{{tffile "examples/resources/sleep/example_3.tf"}}

## Argument Reference

Expand All @@ -900,11 +900,11 @@ This resource can be imported with the `create_duration` and `destroy_duration`,

e.g. For 30 seconds create duration with no destroy duration:

{{codefile "shell" "$WORK/examples/resources/sleep/import_1.sh"}}
{{codefile "shell" "examples/resources/sleep/import_1.sh"}}

e.g. For 30 seconds destroy duration with no create duration:

{{codefile "shell" "$WORK/examples/resources/sleep/import_2.sh"}}
{{codefile "shell" "examples/resources/sleep/import_2.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/static.md.tmpl --
Expand All @@ -928,11 +928,11 @@ Manages a static time resource, which keeps a locally sourced UTC timestamp stor

### Basic Usage

{{tffile "$WORK/examples/resources/static/example_1.tf"}}
{{tffile "examples/resources/static/example_1.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/static/example_2.tf"}}
{{tffile "examples/resources/static/example_2.tf"}}

## Argument Reference

Expand All @@ -959,6 +959,6 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the UTC RFC3339 value, e.g.

{{codefile "shell" "$WORK/examples/resources/static/import_1.sh"}}
{{codefile "shell" "examples/resources/static/import_1.sh"}}

The `triggers` argument cannot be imported.
32 changes: 16 additions & 16 deletions ...lugindocs/testdata/scripts/schema-json/migrate/time_provider_success_legacy_website.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ These resources provide an optional map argument called `triggers` that can be p

For example:

{{tffile "$WORK/examples/example_1.tf"}}
{{tffile "examples/example_1.tf"}}

`triggers` are *not* treated as sensitive attributes; a value used for `triggers` will be displayed in Terraform UI output as plaintext.

Expand All @@ -717,7 +717,7 @@ Given an RFC3339 timestamp string, will parse and return an object representatio

## Example Usage

{{tffile "$WORK/examples/functions/rfc3339_parse/example_1.tf"}}
{{tffile "examples/functions/rfc3339_parse/example_1.tf"}}

## Signature

Expand Down Expand Up @@ -749,11 +749,11 @@ Manages an offset time resource, which keeps an UTC timestamp stored in the Terr

### Basic Usage

{{tffile "$WORK/examples/resources/offset/example_1.tf"}}
{{tffile "examples/resources/offset/example_1.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/offset/example_2.tf"}}
{{tffile "examples/resources/offset/example_2.tf"}}

## Argument Reference

Expand Down Expand Up @@ -788,7 +788,7 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the base UTC RFC3339 timestamp and offset years, months, days, hours, minutes, and seconds, separated by commas (`,`), e.g.

{{codefile "shell" "$WORK/examples/resources/offset/import_1.sh"}}
{{codefile "shell" "examples/resources/offset/import_1.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/rotating.md.tmpl --
Expand All @@ -812,7 +812,7 @@ Manages a rotating time resource, which keeps a rotating UTC timestamp stored in

This example configuration will rotate (destroy/create) the resource every 30 days.

{{tffile "$WORK/examples/resources/rotating/example_1.tf"}}
{{tffile "examples/resources/rotating/example_1.tf"}}

## Argument Reference

Expand Down Expand Up @@ -846,11 +846,11 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the base UTC RFC3339 value and rotation years, months, days, hours, and minutes, separated by commas (`,`), e.g. for 30 days

{{codefile "shell" "$WORK/examples/resources/rotating/import_1.sh"}}
{{codefile "shell" "examples/resources/rotating/import_1.sh"}}

Otherwise, to import with the rotation RFC3339 value, the base UTC RFC3339 value and rotation UTC RFC3339 value, separated by commas (`,`), e.g.

{{codefile "shell" "$WORK/examples/resources/rotating/import_2.sh"}}
{{codefile "shell" "examples/resources/rotating/import_2.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/sleep.md.tmpl --
Expand All @@ -874,15 +874,15 @@ Manages a resource that delays creation and/or destruction, typically for furthe

### Delay Create Usage

{{tffile "$WORK/examples/resources/sleep/example_1.tf"}}
{{tffile "examples/resources/sleep/example_1.tf"}}

### Delay Destroy Usage

{{tffile "$WORK/examples/resources/sleep/example_2.tf"}}
{{tffile "examples/resources/sleep/example_2.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/sleep/example_3.tf"}}
{{tffile "examples/resources/sleep/example_3.tf"}}

## Argument Reference

Expand All @@ -904,11 +904,11 @@ This resource can be imported with the `create_duration` and `destroy_duration`,

e.g. For 30 seconds create duration with no destroy duration:

{{codefile "shell" "$WORK/examples/resources/sleep/import_1.sh"}}
{{codefile "shell" "examples/resources/sleep/import_1.sh"}}

e.g. For 30 seconds destroy duration with no create duration:

{{codefile "shell" "$WORK/examples/resources/sleep/import_2.sh"}}
{{codefile "shell" "examples/resources/sleep/import_2.sh"}}

The `triggers` argument cannot be imported.
-- exp-templates/resources/static.md.tmpl --
Expand All @@ -932,11 +932,11 @@ Manages a static time resource, which keeps a locally sourced UTC timestamp stor

### Basic Usage

{{tffile "$WORK/examples/resources/static/example_1.tf"}}
{{tffile "examples/resources/static/example_1.tf"}}

### Triggers Usage

{{tffile "$WORK/examples/resources/static/example_2.tf"}}
{{tffile "examples/resources/static/example_2.tf"}}

## Argument Reference

Expand All @@ -963,6 +963,6 @@ In addition to all arguments above, the following attributes are exported:

This resource can be imported using the UTC RFC3339 value, e.g.

{{codefile "shell" "$WORK/examples/resources/static/import_1.sh"}}
{{codefile "shell" "examples/resources/static/import_1.sh"}}

The `triggers` argument cannot be imported.
8 changes: 4 additions & 4 deletions internal/provider/migrate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,16 +294,16 @@ func (m *migrator) ExtractCodeExamples(content []byte, newRelDir string, templat
exampleCount++
ext = ".tf"
exampleName = "example_" + strconv.Itoa(exampleCount) + ext
examplePath = filepath.Join(m.ProviderExamplesDir(), newRelDir, exampleName)
examplePath = filepath.Join(m.examplesDir, newRelDir, exampleName)
template = fmt.Sprintf("{{tffile \"%s\"}}", examplePath)
m.infof("creating example file %q", examplePath)
m.infof("creating example file %q", filepath.Join(m.providerDir, examplePath))
case "console":
importCount++
ext = ".sh"
exampleName = "import_" + strconv.Itoa(importCount) + ext
examplePath = filepath.Join(m.ProviderExamplesDir(), newRelDir, exampleName)
examplePath = filepath.Join(m.examplesDir, newRelDir, exampleName)
template = fmt.Sprintf("{{codefile \"shell\" \"%s\"}}", examplePath)
m.infof("creating import file %q", examplePath)
m.infof("creating import file %q", filepath.Join(m.providerDir, examplePath))
default:
// Render node as is
m.infof("skipping code block with unknown language %q", lang)
Expand Down
10 changes: 7 additions & 3 deletions internal/provider/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,13 @@ func resourceSchema(schemas map[string]*tfjson.Schema, providerShortName, templa

func writeFile(path string, data string) error {
dir, _ := filepath.Split(path)
err := os.MkdirAll(dir, 0755)
if err != nil {
return fmt.Errorf("unable to make dir %q: %w", dir, err)

var err error
if dir != "" {
err = os.MkdirAll(dir, 0755)
if err != nil {
return fmt.Errorf("unable to make dir %q: %w", dir, err)
}
}

err = os.WriteFile(path, []byte(data), 0644)
Expand Down