cloudevents
/
sdk-powershell
mirror of https://github.com/cloudevents/sdk-powershell.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Renames Add-CloudEvent*Data to Set-CloudEvent*Data (#12) 

* Addresses issue #9 renaming Add-CloudEvent*Data functions to Set-CloudEvent*Data. As described in the issue the Add notion is not correct for the functions functionality. Set verb notion matches the behavior of the functions.
* Increment minor version of the module. The module is not yet released but this is a backward compatibility breaking change.
* Remove module catalog file creation from build.ps1 because catalog file is needed only when module is signed. We still don't have a signing implementation for this module.
* Explicitly set `-Depth` parameter for `Set-CloudEventJsonData` function in the tests
Signed-off-by: Dimitar Milov <dmilov@vmware.com>
This commit is contained in:
dmilov 2021-04-13 18:41:40 +03:00 committed by GitHub
parent f23df54f30
commit d305f1642b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 74 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
build.ps1
View File

@ -90,12 +90,3 @@ Start-Tests -TestsType 'unit'
# 5. Run Integration Tests
Start-Tests -TestsType 'integration'
# 6. Prepare Module for Publishing
$dirItem = Get-Item $OutputDir
$catalogFilePath = Join-path $OutputDir ($dirItem.Name + ".cat")
if (Test-Path $catalogFilePath) {
# Delete previous catalog file
Remove-Item $catalogFilePath -Confirm:$false
}
New-FileCatalog -Path $OutputDir -CatalogFilePath $catalogFilePath | Out-Null

4
src/CloudEventsPowerShell/CloudEvents.Sdk.psd1
View File

@ -9,7 +9,7 @@
RootModule = 'CloudEvents.Sdk.psm1'
# Version number of this module.
ModuleVersion = '0.1.4'
ModuleVersion = '0.2.0'
# Supported PSEditions
CompatiblePSEditions = @('Core')
@ -67,7 +67,7 @@ RequiredAssemblies = @('CloudNative.CloudEvents.dll')
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @(
'New-CloudEvent', 'Add-CloudEventData', 'Add-CloudEventJsonData', 'Add-CloudEventXmlData', 'Read-CloudEventData', 'Read-CloudEventJsonData', 'Read-CloudEventXmlData', # CloudEvent Object Functions
'New-CloudEvent', 'Set-CloudEventData', 'Set-CloudEventJsonData', 'Set-CloudEventXmlData', 'Read-CloudEventData', 'Read-CloudEventJsonData', 'Read-CloudEventXmlData', # CloudEvent Object Functions
'ConvertTo-HttpMessage', 'ConvertFrom-HttpMessage' # Http Binding Functions
)

55
src/CloudEventsPowerShell/CloudEvents.Sdk.psm1
View File

@ -72,20 +72,20 @@ PROCESS {
}
}
#region Add Data Functions
function Add-CloudEventData {
#region Set Data Functions
function Set-CloudEventData {
<#
.SYNOPSIS
This function adds data to a cloud event.
This function sets data in a cloud event.
.DESCRIPTION
This function adds data to a cloud event object with the provided parameters.
This function sets data in a cloud event object with the provided parameters.
.PARAMETER CloudEvent
Specifies the cloud event object to add data to.
Specifies the cloud event object that receives the data.
.PARAMETER Data
Specifies the data object that is added to the cloud event 'data' attribute.
Specifies the data object for the cloud event 'data' attribute.
.PARAMETER DataContentType
Specifies the 'datacontenttype' attribute of the cloud event.
@ -93,9 +93,9 @@ function Add-CloudEventData {
.EXAMPLE
$cloudEvent = New-CloudEvent -Type 'com.example.object.deleted.v2' -Source 'mailto:cncf-wg-serverless@lists.cncf.io' -Id '6e8bc430-9c3a-11d9-9669-0800200c9a66' -Time (Get-Date)
$cloudEvent | Add-CloudEventData -Data '<much wow="xml"/>' -DataContentType 'application/xml'
$cloudEvent | Set-CloudEventData -Data '<much wow="xml"/>' -DataContentType 'application/xml'
Adds xml data to the cloud event
Sets xml data to the cloud event
#>
[CmdletBinding()]
@ -135,27 +135,32 @@ PROCESS {
}
function Add-CloudEventJsonData {
function Set-CloudEventJsonData {
<#
.SYNOPSIS
This function adds JSON format data to a cloud event.
This function sets JSON format data in a cloud event.
.DESCRIPTION
This function converts a PowerShell hashtable to JSON format data and adds it to a cloud event.
This function converts a PowerShell hashtable to JSON format data and sets it in a cloud event.
.PARAMETER CloudEvent
Specifies the cloud event object to add data to.
Specifies the cloud event object that receives the data.
.PARAMETER Data
Specifies the PowerShell hashtable object that is added as JSON to the cloud event 'data' attribute.
The 'datacontenttype' attribute is set to 'applicaiton/json'
Specifies the PowerShell hashtable object that is set as JSON on the cloud event 'data' attribute.
The 'datacontenttype' attribute is set to 'application/json'
.PARAMETER Depth
The maximum depth of the input hashtable specified on the `Data` parameter that will be converted to JSON.
This parameter is passed on the `-Depth` parameter of the `ConvertTo-Json` cmdlet.
The default value is 3
.EXAMPLE
$cloudEvent = New-CloudEvent -Type 'com.example.object.deleted.v2' -Source 'mailto:cncf-wg-serverless@lists.cncf.io' -Id '6e8bc430-9c3a-11d9-9669-0800200c9a66' -Time (Get-Date)
$cloudEvent | Add-CloudEventJsonData -Data @{ 'key1' = 'value1'; 'key2' = 'value2'; }
$cloudEvent | Set-CloudEventJsonData -Data @{ 'key1' = 'value1'; 'key2' = 'value2'; }
Adds JSON data to the cloud event
Sets JSON data to the cloud event
#>
[CmdletBinding()]
@ -193,20 +198,20 @@ PROCESS {
}
function Add-CloudEventXmlData {
function Set-CloudEventXmlData {
<#
.SYNOPSIS
This function adds XML format data to a cloud event.
This function sets XML format data in a cloud event.
.DESCRIPTION
This function converts a PowerShell hashtable to XML format data and adds it to a cloud event.
This function converts a PowerShell hashtable to XML format data and sets it in a cloud event.
.PARAMETER CloudEvent
Specifies the cloud event object to add data to.
Specifies the cloud event object that receives the data.
.PARAMETER Data
Specifies the PowerShell hashtable object that is added as XML to the cloud event 'data' attribute.
The 'datacontenttype' attribute is set to 'applicaiton/xml'
Specifies the PowerShell hashtable object that is set as XML on the cloud event 'data' attribute.
The 'datacontenttype' attribute is set to 'application/xml'
.PARAMETER AttributesKeysInElementAttributes
Specifies how to format the XML. If specified and the input Data hashtable has pairs of 'Attributes', 'Value' keys
@ -219,9 +224,9 @@ function Add-CloudEventXmlData {
.EXAMPLE
$cloudEvent = New-CloudEvent -Type 'com.example.object.deleted.v2' -Source 'mailto:cncf-wg-serverless@lists.cncf.io' -Id '6e8bc430-9c3a-11d9-9669-0800200c9a66' -Time (Get-Date)
$cloudEvent | Add-CloudEventXmlData -Data @{ 'key1' = 'value1'; 'key2' = 'value2'; } -AttributesKeysInElementAttributes $true
$cloudEvent | Set-CloudEventXmlData -Data @{ 'key1' = 'value1'; 'key2' = 'value2'; } -AttributesKeysInElementAttributes $true
Adds XML data to the cloud event
Sets XML data in the cloud event
#>
[CmdletBinding()]
@ -256,7 +261,7 @@ PROCESS {
}
}
#endregion Add Data Functions
#endregion Set Data Functions
#region Read Data Functions
function Read-CloudEventData {

10
test/integration/HttpIntegration.Tests.ps1
View File

@ -58,7 +58,7 @@ Describe "Client-Server Integration Tests" {
-Source $script:ClientSource `
-Id 'integration-test-1' `
-Time (Get-Date) | `
Add-CloudEventJsonData -Data @{
Set-CloudEventJsonData -Data @{
'a1' = 'b'
'a2' = 'c'
'a3' = 'd'
@ -106,7 +106,7 @@ Describe "Client-Server Integration Tests" {
-Source $script:ClientSource `
-Id 'integration-test-2' `
-Time (Get-Date) | `
Add-CloudEventXmlData -Data @{
Set-CloudEventXmlData -Data @{
'a1' = @{
'a2' = 'c'
'a3' = 'd'
@ -157,7 +157,7 @@ Describe "Client-Server Integration Tests" {
-Source $script:ClientSource `
-Id 'integration-test-3' `
-Time (Get-Date) | `
Add-CloudEventJsonData -Data @{
Set-CloudEventJsonData -Data @{
'b1' = 'd'
'b2' = 'e'
'b3' = 'f'
@ -205,7 +205,7 @@ Describe "Client-Server Integration Tests" {
-Source $script:ClientSource `
-Id 'integration-test-4' `
-Time (Get-Date) | `
Add-CloudEventXmlData -Data @{
Set-CloudEventXmlData -Data @{
'b1' = @{
'b2' = 'e'
'b3' = 'f'
@ -256,7 +256,7 @@ Describe "Client-Server Integration Tests" {
-Source $script:ClientSource `
-Id 'integration-test-5' `
-Time (Get-Date) | `
Add-CloudEventData `
Set-CloudEventData `
-Data 'This is text data' `
-DataContentType 'application/text'

6
test/integration/HttpServer.ps1
View File

@ -113,15 +113,15 @@ while ( -not $global:serverStopRequested ) {
$requestCloudEventJsonData = $requestCloudEvent | Read-CloudEventJsonData
$requestCloudEventXmlData = $requestCloudEvent | Read-CloudEventXmlData -ConvertMode 'SkipAttributes'
if ($requestCloudEventJsonData) {
$cloudEvent = $cloudEvent | Add-CloudEventJsonData `
$cloudEvent = $cloudEvent | Set-CloudEventJsonData `
-Data $requestCloudEventJsonData
} elseif ($requestCloudEventXmlData) {
$cloudEvent = $cloudEvent | Add-CloudEventXmlData `
$cloudEvent = $cloudEvent | Set-CloudEventXmlData `
-Data $requestCloudEventXmlData `
-AttributesKeysInElementAttributes $false
} else {
$requestCloudEventData = $requestCloudEvent | Read-CloudEventData
$cloudEvent = $cloudEvent | Add-CloudEventData `
$cloudEvent = $cloudEvent | Set-CloudEventData `
-Data $requestCloudEventData `
-DataContentType $requestCloudEvent.DataContentType
}

8
test/unit/ConvertTo-HttpMessage.Tests.ps1
View File

@ -26,7 +26,7 @@ Describe "ConvertTo-HttpMessage Function Tests" {
-Time $expectedTime
$expectedData = @{ 'key1' = 'value2'; 'key3' = 'value4' }
$cloudEvent = Add-CloudEventJsonData `
$cloudEvent = Set-CloudEventJsonData `
-CloudEvent $cloudEvent `
-Data $expectedData
@ -75,7 +75,7 @@ Describe "ConvertTo-HttpMessage Function Tests" {
-Source $expectedSource
$expectedData = '<much wow="xml"/>'
$cloudEvent = Add-CloudEventData `
$cloudEvent = Set-CloudEventData `
-CloudEvent $cloudEvent `
-Data $expectedData `
-DataContentType $expectedDataContentType
@ -120,7 +120,7 @@ Describe "ConvertTo-HttpMessage Function Tests" {
-Time $expectedTime
$expectedData = @{ 'key1' = 'value2'; 'key3' = 'value4' }
$cloudEvent = Add-CloudEventJsonData `
$cloudEvent = Set-CloudEventJsonData `
-CloudEvent $cloudEvent `
-Data $expectedData
@ -185,7 +185,7 @@ Describe "ConvertTo-HttpMessage Function Tests" {
-Source $expectedSource
$expectedData = '<much wow="xml"/>'
$cloudEvent = Add-CloudEventData `
$cloudEvent = Set-CloudEventData `
-CloudEvent $cloudEvent `
-Data $expectedData `
-DataContentType $expectedDataContentType

2
test/unit/Read-CloudEventData.Tests.ps1
View File

@ -16,7 +16,7 @@ Describe "Read-CloudEventData Function Tests" {
$expectedData = '<much wow="xml"/>'
$expectedDataContentType = 'text/xml'
$cloudEvent = $cloudEvent | Add-CloudEventData -Data $expectedData -DataContentType $expectedDataContentType
$cloudEvent = $cloudEvent | Set-CloudEventData -Data $expectedData -DataContentType $expectedDataContentType
# Act
$actual = $cloudEvent | Read-CloudEventData

6
test/unit/Read-CloudEventJsonData.Tests.ps1
View File

@ -14,7 +14,7 @@ Describe "Read-CloudEventJsonData Function Tests" {
$expectedHtData = @{'a' = 'b'}
$cloudEvent = $cloudEvent | Add-CloudEventJsonData -Data $expectedHtData
$cloudEvent = $cloudEvent | Set-CloudEventJsonData -Data $expectedHtData -Depth 1
# Act
$actual = $cloudEvent | Read-CloudEventJsonData
@ -32,7 +32,7 @@ Describe "Read-CloudEventJsonData Function Tests" {
-Type test `
-Source 'urn:test'
$cloudEvent = $cloudEvent | Add-CloudEventData -Data "test" -DataContentType 'application/text'
$cloudEvent = $cloudEvent | Set-CloudEventData -Data "test" -DataContentType 'application/text'
$pre
# Act
@ -58,7 +58,7 @@ Describe "Read-CloudEventJsonData Function Tests" {
}
}
$cloudEvent = $cloudEvent | Add-CloudEventJsonData -Data $expectedHtData -Depth 4
$cloudEvent = $cloudEvent | Set-CloudEventJsonData -Data $expectedHtData -Depth 4
# Act
$actual = $cloudEvent | Read-CloudEventJsonData -Depth 4

6
test/unit/Read-CloudEventXmlData.Tests.ps1
View File

@ -15,7 +15,7 @@ Describe "Read-CloudEventXmlData Function Tests" {
$xmlData = "<a>b</a>"
$expectedHtData = @{'a' = 'b'}
$cloudEvent = $cloudEvent | Add-CloudEventData -Data $xmlData -DataContentType 'application/xml'
$cloudEvent = $cloudEvent | Set-CloudEventData -Data $xmlData -DataContentType 'application/xml'
# Act
$actual = $cloudEvent | Read-CloudEventXmlData -ConvertMode 'SkipAttributes'
@ -33,7 +33,7 @@ Describe "Read-CloudEventXmlData Function Tests" {
-Type test `
-Source 'urn:test'
$cloudEvent = $cloudEvent | Add-CloudEventData -Data "test" -DataContentType 'application/text'
$cloudEvent = $cloudEvent | Set-CloudEventData -Data "test" -DataContentType 'application/text'
$pre
# Act
@ -60,7 +60,7 @@ Describe "Read-CloudEventXmlData Function Tests" {
}
}
$cloudEvent = $cloudEvent | Add-CloudEventData -Data $xmlData -DataContentType 'application/xml'
$cloudEvent = $cloudEvent | Set-CloudEventData -Data $xmlData -DataContentType 'application/xml'
# Act
$actual = $cloudEvent | Read-CloudEventXmlData -ConvertMode 'SkipAttributes'

18
test/unit/Add-CloudEventData.Tests.ps1 → test/unit/Set-CloudEventData.Tests.ps1
View File

@ -3,9 +3,9 @@
# SPDX-License-Identifier: Apache-2.0
# **************************************************************************
Describe "Add-CloudEventData Function Tests" {
Context "Adds Data" {
It 'Adds byte[] data' {
Describe "Set-CloudEventData Function Tests" {
Context "Sets Data" {
It 'Sets byte[] data' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -18,7 +18,7 @@ Describe "Add-CloudEventData Function Tests" {
# Act
$actual = $cloudEvent | `
Add-CloudEventData `
Set-CloudEventData `
-Data $expectedData `
-DataContentType $expectedDataContentType
@ -28,7 +28,7 @@ Describe "Add-CloudEventData Function Tests" {
$actual.Data | Should -Be $expectedData
}
It 'Adds xml text data' {
It 'Sets xml text data' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -41,7 +41,7 @@ Describe "Add-CloudEventData Function Tests" {
# Act
$actual = $cloudEvent | `
Add-CloudEventData `
Set-CloudEventData `
-Data $expectedData `
-DataContentType $expectedDataContentType
@ -64,7 +64,7 @@ Describe "Add-CloudEventData Function Tests" {
-Source 'urn:test'
# Act & Assert
{ Add-CloudEventData `
{ Set-CloudEventData `
-CloudEvent $cloudEvent `
-Data '1' `
-DataContentType $invalidContentType } | `
@ -81,7 +81,7 @@ Describe "Add-CloudEventData Function Tests" {
-Source 'urn:test'
# Act & Assert
{ Add-CloudEventData `
{ Set-CloudEventData `
-CloudEvent $cloudEvent `
-Data '1' `
-DataContentType $invalidContentType } | `
@ -98,7 +98,7 @@ Describe "Add-CloudEventData Function Tests" {
-Source 'urn:test'
# Act & Assert
{ Add-CloudEventData `
{ Set-CloudEventData `
-CloudEvent $cloudEvent `
-Data '1' `
-DataContentType $invalidContentType } | `

12
test/unit/Add-CloudEventJsonData.Tests.ps1 → test/unit/Set-CloudEventJsonData.Tests.ps1
View File

@ -3,9 +3,9 @@
# SPDX-License-Identifier: Apache-2.0
# **************************************************************************
Describe "Add-CloudEventJsonData Function Tests" {
Context "Adds Json Data" {
It 'Adds json data with depth 1' {
Describe "Set-CloudEventJsonData Function Tests" {
Context "Sets Json Data" {
It 'Sets json data with depth 1' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -19,7 +19,7 @@ Describe "Add-CloudEventJsonData Function Tests" {
$htData = @{'a' = 'b'}
# Act
$actual = $cloudEvent | Add-CloudEventJsonData -Data $htData
$actual = $cloudEvent | Set-CloudEventJsonData -Data $htData -Depth 1
# Assert
$actual | Should -Not -Be $null
@ -27,7 +27,7 @@ Describe "Add-CloudEventJsonData Function Tests" {
$actual.Data | Should -Be $expectedJson
}
It 'Adds json data with depth 4' {
It 'Sets json data with depth 4' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -55,7 +55,7 @@ Describe "Add-CloudEventJsonData Function Tests" {
}
# Act
$actual = $cloudEvent | Add-CloudEventJsonData -Data $htData -Depth 4
$actual = $cloudEvent | Set-CloudEventJsonData -Data $htData -Depth 4
# Assert
$actual | Should -Not -Be $null

16
test/unit/Add-CloudEventXmlData.Tests.ps1 → test/unit/Set-CloudEventXmlData.Tests.ps1
View File

@ -3,9 +3,9 @@
# SPDX-License-Identifier: Apache-2.0
# **************************************************************************
Describe "Add-CloudEventXmlData Function Tests" {
Context "Adds Xml Data" {
It 'Adds xml data with depth 1' {
Describe "Set-CloudEventXmlData Function Tests" {
Context "Sets Xml Data" {
It 'Sets xml data with depth 1' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -17,7 +17,7 @@ Describe "Add-CloudEventXmlData Function Tests" {
$htData = @{'a' = 'b'}
# Act
$actual = $cloudEvent | Add-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false
$actual = $cloudEvent | Set-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false
# Assert
$actual | Should -Not -Be $null
@ -25,7 +25,7 @@ Describe "Add-CloudEventXmlData Function Tests" {
$actual.Data | Should -Be $expectedXml
}
It 'Adds xml data with depth 4' {
It 'Sets xml data with depth 4' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -45,7 +45,7 @@ Describe "Add-CloudEventXmlData Function Tests" {
}
# Act
$actual = $cloudEvent | Add-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false
$actual = $cloudEvent | Set-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false
# Assert
$actual | Should -Not -Be $null
@ -53,7 +53,7 @@ Describe "Add-CloudEventXmlData Function Tests" {
$actual.Data | Should -Be $expectedXml
}
It 'Should throw when no single root key hashtable is passed to the Add-CloudEventXmlData Data parameter' {
It 'Should throw when no single root key hashtable is passed to the Set-CloudEventXmlData Data parameter' {
# Arrange
$cloudEvent = New-CloudEvent `
-Id ([Guid]::NewGuid()) `
@ -66,7 +66,7 @@ Describe "Add-CloudEventXmlData Function Tests" {
}
# Act & Assert
{ $cloudEvent | Add-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false} | `
{ $cloudEvent | Set-CloudEventXmlData -Data $htData -AttributesKeysInElementAttributes $false} | `
Should -Throw '*Input Hashtable must have single root key*'
}
}