Follow symlinks when creating archive (#183)

* Follow symlinks when creating archive (#6)

Co-authored-by: moajo <[email protected]>

* Adding changie entries (#6)

* Modifying changie entries (#6)

* Switching to using filepath.EvalSymlinks and adding acceptance test coverage (#6)

* Removing unused constant (#6)

* Checking usage of absolute file path in test (#6)

* Adding further symlink acceptance tests to archive_file data source and resource (#6)

* Cleaning up test fixtures (#6)

* Adding symlink dir in regular dir for test fixtures (#6)

* Calling ToSlash() before Abs() (#6)

* Only call ToSlash() if not using Abs() (#6)

* Calling ToSlash() after calling Abs() (#6)

* Amending final test step in TestAccArchiveFile_Symlinks to use ToSlash() (#6)

* Adding test for multiple directories and files (#6)

* Fix resource test (#6)

* Adding optional attribute for following symlinks (#6)

* Modifying tests to pass on windows (#6)

* Altering attribute name to exclude_symlink_directories, which default to false (#6)

* Updating attribute description and regenerating the documentation (#6)

* Updating change log entries (#6)

* Renaming tests (#6)

* Separating each of the acceptance tests for symlinks into individual tests (#6)

---------

Co-authored-by: moajo <[email protected]>

Author: bendbennett

.changes/unreleased/ENHANCEMENTS-20230606-065824.yaml

@@ -0,0 +1,7 @@
+kind: ENHANCEMENTS
+body: 'data-source/archive_file: Added attribute `exclude_symlink_directories` which
+  will exclude symbolically linked directories from the archive when set to true.
+  Defaults to false'
+time: 2023-06-06T06:58:24.84474+01:00
+custom:
+  Issue: "183"

.changes/unreleased/ENHANCEMENTS-20230606-065847.yaml

@@ -0,0 +1,7 @@
+kind: ENHANCEMENTS
+body: 'resource/archive_file: Added attribute `exclude_symlink_directories` which
+  will exclude symbolically linked directories from the archive when set to true.
+  Defaults to false'
+time: 2023-06-06T06:58:47.674171+01:00
+custom:
+  Issue: "183"

docs/data-sources/file.md

@@ -69,6 +69,7 @@ data "archive_file" "lambda_my_function" {
 
 ### Optional
 
+- `exclude_symlink_directories` (Boolean) Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.
 - `excludes` (Set of String) Specify files to ignore when reading the `source_dir`.
 - `output_file_mode` (String) String that specifies the octal file mode for all archived files. For example: `"0666"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior.
 - `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. (see [below for nested schema](#nestedblock--source))

docs/resources/file.md

@@ -22,6 +22,7 @@ description: |-
 
 ### Optional
 
+- `exclude_symlink_directories` (Boolean) Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.
 - `excludes` (Set of String) Specify files to ignore when reading the `source_dir`.
 - `output_file_mode` (String) String that specifies the octal file mode for all archived files. For example: `"0666"`. Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior.
 - `source` (Block Set) Specifies attributes of a single source file to include into the archive. One and only one of `source`, `source_content_filename` (with `source_content`), `source_file`, or `source_dir` must be specified. (see [below for nested schema](#nestedblock--source))

internal/provider/archiver.go

@@ -5,10 +5,15 @@ import (
 	"os"
 )
 
+type ArchiveDirOpts struct {
+	Excludes                  []string
+	ExcludeSymlinkDirectories bool
+}
+
 type Archiver interface {
 	ArchiveContent(content []byte, infilename string) error
 	ArchiveFile(infilename string) error
-	ArchiveDir(indirname string, excludes []string) error
+	ArchiveDir(indirname string, opts ArchiveDirOpts) error
 	ArchiveMultiple(content map[string][]byte) error
 	SetOutputFileMode(outputFileMode string)
 }

internal/provider/data_source_archive_file.go

@@ -142,6 +142,11 @@ func (d *archiveFileDataSource) Schema(ctx context.Context, req datasource.Schem
 					),
 				},
 			},
+			"exclude_symlink_directories": schema.BoolAttribute{
+				Optional: true,
+				Description: "Boolean flag indicating whether symbolically linked directories should be excluded during " +
+					"the creation of the archive. Defaults to false.",
+			},
 			"output_path": schema.StringAttribute{
 				Description: "The output of the archive file.",
 				Required:    true,
@@ -211,7 +216,15 @@ func archive(ctx context.Context, model fileModel) error {
 			}
 		}
 
-		if err := archiver.ArchiveDir(model.SourceDir.ValueString(), excludeList); err != nil {
+		opts := ArchiveDirOpts{
+			Excludes: excludeList,
+		}
+
+		if !model.ExcludeSymlinkDirectories.IsNull() {
+			opts.ExcludeSymlinkDirectories = model.ExcludeSymlinkDirectories.ValueBool()
+		}
+
+		if err := archiver.ArchiveDir(model.SourceDir.ValueString(), opts); err != nil {
 			return fmt.Errorf("error archiving directory: %s", err)
 		}
 	case !model.SourceFile.IsNull():
@@ -309,23 +322,24 @@ func (d *archiveFileDataSource) Metadata(_ context.Context, req datasource.Metad
 }
 
 type fileModel struct {
-	ID                    types.String `tfsdk:"id"`
-	Source                types.Set    `tfsdk:"source"` // sourceModel
-	Type                  types.String `tfsdk:"type"`
-	SourceContent         types.String `tfsdk:"source_content"`
-	SourceContentFilename types.String `tfsdk:"source_content_filename"`
-	SourceFile            types.String `tfsdk:"source_file"`
-	SourceDir             types.String `tfsdk:"source_dir"`
-	Excludes              types.Set    `tfsdk:"excludes"`
-	OutputPath            types.String `tfsdk:"output_path"`
-	OutputSize            types.Int64  `tfsdk:"output_size"`
-	OutputFileMode        types.String `tfsdk:"output_file_mode"`
-	OutputMd5             types.String `tfsdk:"output_md5"`
-	OutputSha             types.String `tfsdk:"output_sha"`
-	OutputSha256          types.String `tfsdk:"output_sha256"`
-	OutputBase64Sha256    types.String `tfsdk:"output_base64sha256"`
-	OutputSha512          types.String `tfsdk:"output_sha512"`
-	OutputBase64Sha512    types.String `tfsdk:"output_base64sha512"`
+	ID                        types.String `tfsdk:"id"`
+	Source                    types.Set    `tfsdk:"source"` // sourceModel
+	Type                      types.String `tfsdk:"type"`
+	SourceContent             types.String `tfsdk:"source_content"`
+	SourceContentFilename     types.String `tfsdk:"source_content_filename"`
+	SourceFile                types.String `tfsdk:"source_file"`
+	SourceDir                 types.String `tfsdk:"source_dir"`
+	Excludes                  types.Set    `tfsdk:"excludes"`
+	ExcludeSymlinkDirectories types.Bool   `tfsdk:"exclude_symlink_directories"`
+	OutputPath                types.String `tfsdk:"output_path"`
+	OutputSize                types.Int64  `tfsdk:"output_size"`
+	OutputFileMode            types.String `tfsdk:"output_file_mode"`
+	OutputMd5                 types.String `tfsdk:"output_md5"`
+	OutputSha                 types.String `tfsdk:"output_sha"`
+	OutputSha256              types.String `tfsdk:"output_sha256"`
+	OutputBase64Sha256        types.String `tfsdk:"output_base64sha256"`
+	OutputSha512              types.String `tfsdk:"output_sha512"`
+	OutputBase64Sha512        types.String `tfsdk:"output_base64sha512"`
 }
 
 type sourceModel struct {