Fix file resource

adityapatwardhan · adityapatwardhan · commit c8a1d5394ebb · 2025-03-17T15:15:44.000-07:00
diff --git a/dsc/examples/filesys_create.dsc.yaml b/dsc/examples/filesys_create.dsc.yaml
@@ -1,8 +1,9 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Create empty file
   type: Microsoft.DSC/File
   properties:
-    path: "[path(envar(TEMP), 'test-file-resource.txt')]"
+    path: "[envvar('TEMP')]"
+    name: 'test-file-resource.txt'
     _exist: true
diff --git a/dsc/examples/filesys_delete.dsc.yaml b/dsc/examples/filesys_delete.dsc.yaml
@@ -1,8 +1,9 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Create empty file
   type: Microsoft.DSC/File
   properties:
-    path: "[path(envar(TEMP), 'test-file-resource.txt')]"
+    path: '[path(envvar('TEMP'))]''
+    name: 'test-file-resource.txt'
     _exist: false
diff --git a/dsc/examples/filesys_dir_create.dsc.yaml b/dsc/examples/filesys_dir_create.dsc.yaml
@@ -1,8 +1,8 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Create empty directory
   type: Microsoft.DSC/Directory
   properties:
-    path: "[path(envar(TEMP), 'test-file-resource.txt')]"
+    path: "[path(envvar('TEMP'), 'test-directory')]"
     _exist: true
diff --git a/dsc/examples/filesys_dir_delete.dsc.yaml b/dsc/examples/filesys_dir_delete.dsc.yaml
@@ -1,8 +1,8 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Delete empty directory
   type: Microsoft.DSC/Directory
   properties:
-    path: "[path(envar(TEMP), 'testdir')]"
+    path: "[path(envvar('TEMP'), 'test-dir-resource')]"
     _exist: false
diff --git a/dsc/examples/filesys_dir_delete_recurse.dsc.yaml b/dsc/examples/filesys_dir_delete_recurse.dsc.yaml
@@ -1,9 +1,9 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Delete non-empty directory
   type: Microsoft.DSC/Directory
   properties:
-    path: "[path(envar(TEMP), 'testdir')]"
+    path: "[path(envvar('TEMP'), 'test-dir-resource')]"
     recurse: true
     _exist: false
diff --git a/dsc/examples/filesys_filecontent.dsc.yaml b/dsc/examples/filesys_filecontent.dsc.yaml
@@ -1,9 +1,10 @@
 # Example configuration mixing native app resources with classic PS resources
-$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Set file content
   type: Microsoft.DSC/FileContent
   properties:
-    path: "[path(envar(TEMP), 'test-file-resource.txt')]"
+    path: '[path(envvar('TEMP'))]''
+    name: 'test-file-resource.txt'
     content: "Hello, World!"
     _exist: true
diff --git a/dsc/tests/filesys.tests.ps1 b/dsc/tests/filesys.tests.ps1
@@ -0,0 +1,89 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Describe 'FileSys resoure tests' {
+    BeforeAll {
+        $testDir = Join-Path $env:TEMP 'test-dir-resource'
+        $testFile = Join-Path $testDir 'test-file-resource.txt'
+        $testFileName = 'test-file-resource.txt'
+    }
+
+    It 'Filesys resource can create file' {
+        if (Test-Path $testFile) {
+            Remove-Item -Path $testFile -Force
+        }
+
+        $resultJson = dsc config set -f "$PSScriptRoot/../examples/filesys_create.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $path = $resultJson.results.result.afterState.path
+        $name = $resultJson.results.result.afterState.name
+
+        $path | Should -Be $env:TEMP
+        (Join-Path $path $name) | Should -Exist
+        Get-Item $resultJson.results.result.afterState.path | Should -BeOfType 'System.IO.FileInfo'
+    }
+
+    It 'Filesys resource can create directory' {
+        $resultJson = dsc config set -f "../examples/filesys_dir_create.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $resultJson.results.result.afterState.path | Should -Exist
+        Get-Item $resultJson.results.result.afterState.path | Should -BeOfType 'System.IO.DirectoryInfo'
+
+    }
+
+    It 'Filesys resource can create file with content' {
+        $resultJson = dsc config set -f "../examples/filesys_filecontent.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+
+        $resultFilePath = $resultJson.results.result.afterState.path
+        $resultFilePath | Should -Exist
+        Get-Content $resultFilePath | Should -Be "Hello, World!"
+    }
+
+    It 'Filesys resource can delete a file' {
+        if (-not (Test-Path $testFile)) {
+            New-Item -Path $testFile -ItemType File -Force | Out-Null
+        }
+
+        $resultJson = dsc config set -f "../examples/filesys_delete.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $resultFilePath = $resultJson.results.result.afterState.path
+        $resultFilePath | Should -Not -Exist
+    }
+
+    It 'Filesys resource can delete an empty directory' -Pending {
+        if (-not (Test-Path $testDir)) {
+            New-Item -Path $testDir -ItemType Directory -Force | Out-Null
+        }
+
+        $resultJson = dsc config set -f "../examples/filesys_dir_delete.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $resultDirPath = $resultJson.results.result.afterState.path
+        $resultDirPath | Should -Not -Exist
+    }
+
+    It 'Filesys resource can delete a non-empty directory' -Pending {
+        if (-not (Test-Path $testDir)) {
+            New-Item -Path $testDir -ItemType Directory -Force | Out-Null
+            New-Item -Path (Join-Path $testDir $testFileName) -ItemType File -Force | Out-Null
+        }
+
+        $resultJson = dsc config set -f "../examples/filesys_dir_delete.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $resultDirPath = $resultJson.results.result.afterState.path
+        $resultDirPath | Should -Not -Exist
+    }
+
+    It 'Filesys resource can delete a directory recursively' -Pending {
+        if (-not (Test-Path $testDir)) {
+            $dirPath = New-Item -Path $testDir -ItemType Directory -Force | Out-Null
+            $subDirPath = New-Item -Path (Join-Path $dirPath 'test-subdir') -ItemType Directory -Force | Out-Null
+            New-Item -Path (Join-Path $subDirPath $testFileName) -ItemType File -Force | Out-Null
+        }
+
+        $resultJson = dsc config set -f "../examples/filesys_dir_delete_recursive.dsc.yaml" | ConvertFrom-Json
+        $resultJson.hadErrors | Should -BeFalse
+        $resultDirPath = $resultJson.results.result.afterState.path
+        $resultDirPath | Should -Not -Exist
+    }
+}
diff --git a/pal/Cargo.toml b/pal/Cargo.toml
@@ -13,4 +13,4 @@ opt-level = 2
 lto = true
 
 [build-dependencies]
-cc = "1.1"
+cc = "~1.1"
diff --git a/resources/filesys/src/config.rs b/resources/filesys/src/config.rs
@@ -10,6 +10,8 @@ pub struct File {
     /// The path to the file.
     pub path: String,
 
+    pub name: String,
+
     /// The file size.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub size: Option<u64>,
@@ -50,6 +52,9 @@ pub struct FileContent
     /// The path to the file.
     pub path: String,
 
+    /// The file name.
+    pub name: String,
+
     /// The file hash. If not provided, the hash is calculated from the content.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub hash: Option<String>,
diff --git a/resources/filesys/src/dir_helpers.rs b/resources/filesys/src/dir_helpers.rs
@@ -98,7 +98,7 @@ pub fn export_dir_path(dir: &Directory) -> Result<Directory, Box<dyn std::error:
                 for entry in dir {
                     let entry = entry?;
                     let path = entry.path();
-                    let f = File::new(path.to_str().unwrap());
+                    let f = File::new(path.to_str().unwrap(), path.file_name().unwrap().to_str().unwrap());
                     files.push(get_file(&f)?);
                 }
                 files
@@ -110,7 +110,7 @@ pub fn export_dir_path(dir: &Directory) -> Result<Directory, Box<dyn std::error:
         }
         false => {
             let path = Path::new(path);
-            let f = File::new(path.to_str().unwrap());
+            let f = File::new(path.to_str().unwrap(), path.file_name().unwrap().to_str().unwrap());
             let file = get_file(&f)?;
             let parent = path.parent();
             match parent {
diff --git a/resources/filesys/src/file_helper.rs b/resources/filesys/src/file_helper.rs
@@ -14,9 +14,10 @@ impl File {
     ///
     /// * `string` - The string for the Path
     #[must_use]
-    pub fn new(path: &str) -> File {
+    pub fn new(path: &str, name: &str) -> File {
         File {
             path: path.to_string(),
+            name: name.to_string(),
             size: None,
             hash: None,
             exist: None,
@@ -25,7 +26,7 @@ impl File {
 }
 
 pub fn get_file(file: &File) -> Result<File, Box<dyn std::error::Error>> {
-    debug!("In get_file");
+    println!("In get_file");
     match compare_file_state(file) {
         Ok(f) => {
             Ok(f)
@@ -40,30 +41,33 @@ pub fn set_file(file: &File) -> Result<File, Box<dyn std::error::Error>> {
     match compare_file_state(file) {
         Ok(_) => {
             debug!("In set_file");
-            debug!("file exist {:?}", file_exists(file.path.as_str()));
+            debug!("file exist {:?}", file_exists(file.path.as_str(), file.name.as_str()));
             debug!("expected file exist {:?}", file.exist.unwrap_or(true));
 
-            match (file_exists(file.path.as_str()), file.exist.unwrap_or(true)) {
+            let resolved_path = Path::new(file.path.as_str()).join(file.name.as_str());
+
+            match (file_exists(file.path.as_str(), file.name.as_str()), file.exist.unwrap_or(true)) {
+
                 // if the current file exists and expected state is exist == false, delete it
                 (true, false) => {
-                    debug!("Deleting file: {:?}", file.path);
-                    fs::remove_file(file.path.as_str())?;
+                    debug!("Deleting file: {:?}", resolved_path);
+                    fs::remove_file(resolved_path)?;
                     Ok(get_file(&file)?)
                 }
 
                 // if the current file does not exist and expected state is exist == true, create it
                 (false, true) => {
-                    debug!("Creating file: {:?}", file.path);
-                    fsFile::create(file.path.as_str())?;
-                    let new_file = File::new(file.path.as_str());
+                    debug!("Creating file: {:?}", resolved_path);
+                    fsFile::create(resolved_path)?;
+                    let new_file = File::new(file.path.as_str(), file.name.as_str());
 
                     Ok(get_file(&new_file)?)
                 }
 
                 // if the current file exists and expected state is exist == true or both are false update and return
                 (true, true) | (false, false) => {
-                    debug!("Updating file: {:?}", file.path);
-                    let new_file = File::new(file.path.as_str());
+                    println!("Updating file: {:?}", resolved_path);
+                    let new_file = File::new(file.path.as_str(), file.name.as_str());
                     Ok(get_file(&new_file)?)
                 }
             }
@@ -99,8 +103,8 @@ pub fn delete_file(file: &File) -> Result<(), Box<dyn std::error::Error>> {
 }
 
 fn compare_file_state(file: &File) -> Result<File, Box<dyn std::error::Error>> {
-    let resolved_path = Path::new(file.path.as_str());
-    debug!("Resolved path: {:?}", resolved_path);
+    let resolved_path = Path::new(file.path.as_str()).join(file.name.as_str());
+    println!("Resolved path: {:?}", resolved_path);
     match resolved_path.is_dir() {
         true => {
             // debug!("Path is a directory");
@@ -111,9 +115,9 @@ fn compare_file_state(file: &File) -> Result<File, Box<dyn std::error::Error>> {
         }
         false => {}
     }
-    let f: fsFile = match fsFile::open(resolved_path) {
+    let f: fsFile = match fsFile::open(resolved_path.clone()) {
         Ok(f) => {
-            debug!("File found: {:?}", file.path);
+            debug!("File found: {:?}", resolved_path.clone());
             f
         },
         Err(e) => {
@@ -129,12 +133,12 @@ fn compare_file_state(file: &File) -> Result<File, Box<dyn std::error::Error>> {
         }
     };
 
-    let hash = calculate_hash(file.path.as_str())?;
+    let hash = calculate_hash(resolved_path.to_str().unwrap())?;
 
     match file.hash.as_ref() {
         Some(h) => {
             if h.to_lowercase() != hash.to_lowercase() {
-                debug!("Hash mismatch: {:?}", file.path);
+                debug!("Hash mismatch");
                 let mut updated_file = file.clone();
                 updated_file.exist = Some(false);
                 return Ok(updated_file)
@@ -164,7 +168,7 @@ pub fn calculate_hash(path: &str) -> Result<String, Box<dyn std::error::Error>>
     Ok(digest)
 }
 
-fn file_exists(path: &str) -> bool {
-    let resolved_path = Path::new(path);
+fn file_exists(path: &str, name: &str) -> bool {
+    let resolved_path = Path::new(path).join(name);
     return resolved_path.exists();
 }
diff --git a/resources/filesys/src/filecontent_helper.rs b/resources/filesys/src/filecontent_helper.rs
@@ -25,9 +25,10 @@ impl FileContent {
     ///
     /// * `string` - The string for the Path
     #[must_use]
-    pub fn new(path: &str) -> FileContent {
+    pub fn new(path: &str, name: &str) -> FileContent {
         FileContent {
             path: path.to_string(),
+            name: name.to_string(),
             content: None,
             hash: None,
             encoding: Some(Encoding::Utf8),
diff --git a/resources/filesys/src/main.rs b/resources/filesys/src/main.rs
@@ -33,14 +33,14 @@ fn main() {
                     println!("{}", json);
                 }
                 None => {
-                    let dir = match is_directory_type(input.as_str()) {
+                    match is_directory_type(input.as_str()) {
                         Some(dir) => {
                             let dir = get_dir(&dir).unwrap();
                             let json = serde_json::to_string(&dir).unwrap();
                             println!("{}", json);
                         }
                         None => {
-                            let filecontent = match is_filecontent_type(input.as_str()) {
+                            match is_filecontent_type(input.as_str()) {
                                 Some(filecontent) => {
                                     let filecontent = get_file_content(&filecontent).unwrap();
                                     let json = serde_json::to_string(&filecontent).unwrap();
@@ -66,14 +66,14 @@ fn main() {
                     println!("{}", json);
                 }
                 None => {
-                    let dir = match is_directory_type(input.as_str()) {
+                    match is_directory_type(input.as_str()) {
                         Some(dir) => {
                             let dir = delete_dir(&dir).unwrap();
                             let json = serde_json::to_string(&dir).unwrap();
                             println!("{}", json);
                         }
                         None => {
-                            let filecontent = match is_filecontent_type(input.as_str()) {
+                            match is_filecontent_type(input.as_str()) {
                                 Some(filecontent) => {
                                     let filecontent = delete_file_content(&filecontent).unwrap();
                                     let json = serde_json::to_string(&filecontent).unwrap();
@@ -100,14 +100,14 @@ fn main() {
                     debug!("File set successfully.");
                 }
                 None => {
-                    let dir = match is_directory_type(input.as_str()) {
+                    match is_directory_type(input.as_str()) {
                         Some(dir) => {
                             let dir = set_dir(&dir).unwrap();
                             let json = serde_json::to_string(&dir).unwrap();
                             println!("{}", json);
                         }
                         None => {
-                            let filecontent = match is_filecontent_type(input.as_str()) {
+                            match is_filecontent_type(input.as_str()) {
                                 Some(filecontent) => {
                                     let filecontent = set_file_content(&filecontent).unwrap();
                                     let json = serde_json::to_string(&filecontent).unwrap();
@@ -134,15 +134,15 @@ fn main() {
                     debug!("File exported successfully.");
                 }
                 None => {
-                    let dir = match is_directory_type(input.as_str()) {
+                    match is_directory_type(input.as_str()) {
                         Some(dir) => {
                             let exported_dir = export_dir_path(&dir).unwrap();
                             let json = serde_json::to_string(&exported_dir).unwrap();
                             println!("{}", json);
                             debug!("File exported successfully.");
                         }
                         None => {
-                            let filecontent = match is_filecontent_type(input.as_str()) {
+                            match is_filecontent_type(input.as_str()) {
                                 Some(filecontent) => {
                                     let filecontent = get_file_content(&filecontent).unwrap();
                                     let json = serde_json::to_string(&filecontent).unwrap();
