DSC/dsc/tests/dsc_export.tests.ps1 at 87e3db44d5a01f1461fb05980c81be41e5a4a19e · PowerShell/DSC · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

Describe 'resource export tests' {
    BeforeAll {
        $env:DSC_TRACE_LEVEL = 'error'
    }

    AfterAll {
        $env:DSC_TRACE_LEVEL = $null
    }

    It 'Export can be called on individual resource' {

        $out = dsc resource export -r Microsoft/Process
        $LASTEXITCODE | Should -Be 0
        $config_with_process_list = $out | ConvertFrom-Json
        $config_with_process_list.'$schema' | Should -BeExactly 'https://aka.ms/dsc/schemas/v3/bundled/config/document.json'
        $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
        $config_with_process_list.resources.count | Should -BeGreaterThan 1
    }

    It 'get --all can be called on individual resource' {

        $out = dsc resource get --all -r Microsoft/Process
        $LASTEXITCODE | Should -Be 0
        $process_list = $out | ConvertFrom-Json
        $process_list.resources.count | Should -BeGreaterThan 1
        $process_list | % {$_.actualState | Should -Not -BeNullOrEmpty}
    }

    It 'Export can be called on a configuration' {

        $yaml = @'
            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
            contentVersion: 1.2.3
            resources:
            - name: Processes
              type: Microsoft/Process
              properties:
                pid: 0
'@
        $out = $yaml | dsc config export -f -
        $LASTEXITCODE | Should -Be 0
        $config_with_process_list = $out | ConvertFrom-Json
        $config_with_process_list.'$schema' | Should -BeExactly 'https://aka.ms/dsc/schemas/v3/bundled/config/document.json'
        $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
        $config_with_process_list.resources.count | Should -BeGreaterThan 1
        $config_with_process_list.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'export'
        # contentVersion on export is always 1.0.0
        $config_with_process_list.contentVersion | Should -BeExactly '1.0.0'
        $config_with_process_list.resources.name | Should -BeLike 'Process-*'
    }

    It 'Configuration Export can be piped to configuration Set' -Skip:(!$IsWindows) {

        $yaml = @'
            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
            resources:
            - name: Processes
              type: Microsoft/Process
              properties:
                pid: 0
'@
        $out = $yaml | dsc config export -f - | dsc config set -f -
        $LASTEXITCODE | Should -Be 0
        $set_results = $out | ConvertFrom-Json
        $set_results.results.count | Should -BeGreaterThan 1
    }

    It 'Duplicate resource types in Configuration Export should not result in error' {

        $yaml = @'
            $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
            resources:
            - name: Processes
              type: Microsoft/Process
              properties:
                pid: 0
            - name: Processes
              type: Microsoft/Process
              properties:
                pid: 0
'@
        $null = $yaml | dsc config export -f - 2>&1
        $LASTEXITCODE | Should -Be 0
    }

    It 'Export can be called on individual resource with the use of --output-format as a subcommand' {

      $out = dsc resource export -r Microsoft/Process -o pretty-json
      $LASTEXITCODE | Should -Be 0
      $config_with_process_list = $out | ConvertFrom-Json
      $config_with_process_list.'$schema' | Should -BeExactly 'https://aka.ms/dsc/schemas/v3/bundled/config/document.json'
      $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
      $config_with_process_list.resources.count | Should -BeGreaterThan 1
    }

    It 'Export can be called on resource with input' {
        $out = '{"count":3}' | dsc resource export -r Test/Export -f - | ConvertFrom-Json
        $LASTEXITCODE | Should -Be 0
        $out.resources.count | Should -Be 3
        $out.resources[0].type | Should -BeExactly 'Test/Export'
        $out.resources[0].properties.count | Should -Be 0
        $out.resources[1].type | Should -BeExactly 'Test/Export'
        $out.resources[1].properties.count | Should -Be 1
        $out.resources[2].type | Should -BeExactly 'Test/Export'
        $out.resources[2].properties.count | Should -Be 2
    }

    It 'Export can be called on a configuration with the use of --output-format as a subcommand' {

      $yaml = @'
          $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
          resources:
          - name: Processes
            type: Microsoft/Process
            properties:
              pid: 0
'@
      $out = $yaml | dsc config export -o pretty-json -f -
      $LASTEXITCODE | Should -Be 0
      $config_with_process_list = $out | ConvertFrom-Json
      $config_with_process_list.'$schema' | Should -BeExactly 'https://aka.ms/dsc/schemas/v3/bundled/config/document.json'
      $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
      $config_with_process_list.resources.count | Should -BeGreaterThan 1
    }

    It 'Export for config preserves metadata' {
        $yaml = @'
          $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
          metadata:
            winget:
              processor: dscv3
            hello: world
          resources:
            - name: OS
              type: Microsoft/OSInfo
'@
        $out = $yaml | dsc config export -f - | ConvertFrom-Json
        $LASTEXITCODE | Should -Be 0
        $out.metadata.winget.processor | Should -BeExactly 'dscv3'
        $out.metadata.hello | Should -BeExactly 'world'
        $out.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'export'
    }

    It 'Works with Exporter resource' {
      $yaml = @'
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
resources:
  - name: export this
    type: Test/Exporter
    properties:
      typeNames:
        - Test/Foo
        - Test/Bar
'@
      $out = dsc config export -i $yaml | ConvertFrom-Json
      $LASTEXITCODE | Should -Be 0
      $out.resources | Should -HaveCount 2
      $out.resources[0].type | Should -BeExactly 'Test/Foo'
      $out.resources[0].name | Should -BeExactly 'test'
      $out.resources[0].properties.psobject.properties | Should -HaveCount 2
      $out.resources[0].properties.foo | Should -BeExactly 'bar'
      $out.resources[0].properties.hello | Should -BeExactly 'world'
      $out.resources[1].type | Should -BeExactly 'Test/Bar'
      $out.resources[1].name | Should -BeExactly 'test'
      $out.resources[1].properties.psobject.properties | Should -HaveCount 2
      $out.resources[1].properties.foo | Should -BeExactly 'bar'
      $out.resources[1].properties.hello | Should -BeExactly 'world'
    }

    It 'Export can surface _kind, _securityContext, and _name from a resource' {
      $yaml = @'
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
resources:
  - name: Test Export
    type: Test/Export
    properties:
      count: 1
'@
        $out = dsc config export -i $yaml | ConvertFrom-Json
        $LASTEXITCODE | Should -Be 0
        $out.resources.count | Should -Be 1
        $out.resources[0].name | Should -BeExactly 'TestName'
        $out.resources[0].kind | Should -BeExactly 'TestKind'
        $out.resources[0].metadata.'Microsoft.DSC'.securityContext | Should -BeExactly 'elevated'
        $out.resources[0].properties.psobject.properties.name | Should -Not -Contain '_kind'
        $out.resources[0].properties.psobject.properties.name | Should -Not -Contain '_securityContext'
        $out.resources[0].properties.psobject.properties.name | Should -Not -Contain '_name'
    }

    It 'Export can be used with a resource that only implements Get with filter' {
      $yaml = @'
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: NoExport
    type: Test/Get
    properties:
      name: two
'@
      $out = dsc config export -i $yaml | ConvertFrom-Json
      $LASTEXITCODE | Should -Be 0
      $out.resources.count | Should -Be 1
      $out.resources[0].type | Should -BeExactly 'Test/Get'
      $out.resources[0].properties.name | Should -BeExactly 'two'
      $out.resources[0].properties.id | Should -Be 2
    }

    It 'Export can be used with a resource that only implements Get with no filter' {
      $yaml = @'
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: NoFilter
    type: Test/Get
'@
      $out = dsc config export -i $yaml | ConvertFrom-Json
      $LASTEXITCODE | Should -Be 0
      $out.resources.count | Should -Be 1
      $out.resources[0].type | Should -BeExactly 'Test/Get'
      $out.resources[0].properties.name | Should -BeExactly 'one'
      $out.resources[0].properties.id | Should -Be 1
    }
}