mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-04 09:43:23 +02:00
484258eb36
* Added Linux-specific detector for the os.description attribute * Generalized OS description detector with placeholder function for unimplemented OSes * Extended osDescription function to *nix OSes based on golang.org/x/sys/unix * Added WithOS resource configuration function to configure all of the OS resource attributes * Implemented osDescription funtion for Windows OS * Improved documentation header for *nix version of the osDescription function * Added support for reading os-release file * Added/updated documentation headers for *nix implementation of osDescription and related functions * Changelog update * Added support for reading macOS version information * Mock approach to test OS description attribute * Extracted common function getFirstAvailableFile to read the first available file from a list of candidates * Upgraded golang.org/x/sys * Changelog update * Fixed wrong function name in documentation header for WithOSDescription * Updated documentation header for platformOSDescription function * Renamed restoreProcessAttributesProviders test helper function The function restoreProcessAttributesProviders was renamed to simply restoreAttributesProviders to better reflect its broader scope, which not only applies to process attribute's providers. * Fixed os_linux.go overriding build tags defined inside the file The suffix on os_linux.go was overriding the build tags already defined in that file. The file was renamed to os_release_unix.go, reflecting the main function defined in the file. For consistency, os_darwin.go was renamed to os_release_darwing.go, as its primary purpose is to also define the osRelease function. * Removed use of discontinued function resource.WithoutBuiltin * Added PR number to changelog entries * Updated go.sum files after run of make lint * Linux implementation: ignore lines with an empty key * Linux implementation: avoid unquoting strings less than two chars * WIP: added tests for Linux support functions * WIP: added tests for charsToString and getFirstAvailableFile functions * Replaced os.CreateTemp with ioutil.TempFile as the former only exists in Go 1.16 * Added unameProvider type to decouple direct reference to unix.Uname function inside Uname() * Added tests for Uname() function * Replaced *os.File with io.Reader in parseOSReleaseFile to ease testing * Added tests for parseOSReleaseFile function * Darwin implementation: added tests for buildOSRelease function * Replaced *os.File with io.Reader in parsePlistFile to ease testing * Darwin implementation: added tests for parsePlistFile function * Type in documentation header for Linux osRelease function * Extracted logic for reading specific registry values into helper functions * Added basic tests for Windows version of platformOSDescription and helper functions * Manually formatted uint64 to strings to have an uniform interface for test assertions * Asserts there's no error when opening registry key for testing Co-authored-by: Robert Pająk <pellared@hotmail.com> * Simplified subtests by using a single test with multiple asserts * go.sum update after running make * Fix typo Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> * WIP: added placeholder implementation of platformOSDescription for unsupported OSes * Fixed typo on osRelease documentation header Co-authored-by: Chris Bandy <bandy.chris@gmail.com> * Fixed typo on test case name for ParsePlistFile tests Co-authored-by: Chris Bandy <bandy.chris@gmail.com> * Linter fix in changelog * go.sum updates after running make * Used strings.Replacer instead of multiple strings.ReplaceAll calls * Optimized implementation of charsToString * Safer temporary file deletion with t.TempDir() * Used t.Cleanup() for safer mocking of runtime providers in OS resource tests * Handled optionality of DisplayVersion registry key. For example, CI machine runs on: Windows Server 2019 Datacenter (1809) [Version 10.0.17763.1999] So, to not add an extra white space due to missing DisplayVersion, this value is checked to be not empty, and only in such case a trailing space is added for that component. * Workaround to handle the case of DisplayVersion registry key not present * Excluded unsupported GOOSes by negation of supported ones * go.sum update after running make Co-authored-by: Anthony Mirabella <a9@aneurysm9.com> Co-authored-by: Robert Pająk <pellared@hotmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> Co-authored-by: Chris Bandy <bandy.chris@gmail.com>
177 lines
4.7 KiB
Go
177 lines
4.7 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package resource_test
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
)
|
|
|
|
func TestParsePlistFile(t *testing.T) {
|
|
standardPlist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>ProductBuildVersion</key>
|
|
<string>20E232</string>
|
|
<key>ProductCopyright</key>
|
|
<string>1983-2021 Apple Inc.</string>
|
|
<key>ProductName</key>
|
|
<string>macOS</string>
|
|
<key>ProductUserVisibleVersion</key>
|
|
<string>11.3</string>
|
|
<key>ProductVersion</key>
|
|
<string>11.3</string>
|
|
<key>iOSSupportVersion</key>
|
|
<string>14.5</string>
|
|
</dict>
|
|
</plist>`)
|
|
|
|
parsedPlist := map[string]string{
|
|
"ProductBuildVersion": "20E232",
|
|
"ProductCopyright": "1983-2021 Apple Inc.",
|
|
"ProductName": "macOS",
|
|
"ProductUserVisibleVersion": "11.3",
|
|
"ProductVersion": "11.3",
|
|
"iOSSupportVersion": "14.5",
|
|
}
|
|
|
|
emptyPlist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
</dict>
|
|
</plist>`)
|
|
|
|
missingDictPlist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
</plist>`)
|
|
|
|
unknownElementsPlist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<a>
|
|
<b>123</b>
|
|
</a>
|
|
<key>ProductBuildVersion</key>
|
|
<c>Value</c>
|
|
<string>20E232</string>
|
|
<d attr="1"></d>
|
|
</dict>
|
|
</plist>`)
|
|
|
|
parsedUnknownElementsPlist := map[string]string{
|
|
"ProductBuildVersion": "20E232",
|
|
}
|
|
|
|
tt := []struct {
|
|
Name string
|
|
Plist io.Reader
|
|
Parsed map[string]string
|
|
}{
|
|
{"Standard", standardPlist, parsedPlist},
|
|
{"Empty", emptyPlist, map[string]string{}},
|
|
{"Missing dict", missingDictPlist, map[string]string{}},
|
|
{"Unknown elements", unknownElementsPlist, parsedUnknownElementsPlist},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
tc := tc
|
|
|
|
t.Run(tc.Name, func(t *testing.T) {
|
|
result, err := resource.ParsePlistFile(tc.Plist)
|
|
|
|
require.Equal(t, tc.Parsed, result)
|
|
require.NoError(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestParsePlistFileUnevenKeys(t *testing.T) {
|
|
plist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>ProductBuildVersion</key>
|
|
<string>20E232</string>
|
|
<key>ProductCopyright</key>
|
|
</dict>
|
|
</plist>`)
|
|
|
|
result, err := resource.ParsePlistFile(plist)
|
|
|
|
require.Nil(t, result)
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestParsePlistFileMalformed(t *testing.T) {
|
|
plist := bytes.NewBufferString(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Product
|
|
</dict>
|
|
</plist>`)
|
|
|
|
result, err := resource.ParsePlistFile(plist)
|
|
|
|
require.Nil(t, result)
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestBuildOSRelease(t *testing.T) {
|
|
tt := []struct {
|
|
Name string
|
|
Properties map[string]string
|
|
OSRelease string
|
|
}{
|
|
{"Empty properties", map[string]string{}, ""},
|
|
{"Empty properties (nil)", nil, ""},
|
|
{"Missing product name", map[string]string{
|
|
"ProductVersion": "11.3",
|
|
"ProductBuildVersion": "20E232",
|
|
}, ""},
|
|
{"Missing product version", map[string]string{
|
|
"ProductName": "macOS",
|
|
"ProductBuildVersion": "20E232",
|
|
}, ""},
|
|
{"Missing product build version", map[string]string{
|
|
"ProductName": "macOS",
|
|
"ProductVersion": "11.3",
|
|
}, ""},
|
|
{"All properties available", map[string]string{
|
|
"ProductName": "macOS",
|
|
"ProductVersion": "11.3",
|
|
"ProductBuildVersion": "20E232",
|
|
}, "macOS 11.3 (20E232)"},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
tc := tc
|
|
|
|
t.Run(tc.Name, func(t *testing.T) {
|
|
result := resource.BuildOSRelease(tc.Properties)
|
|
require.Equal(t, tc.OSRelease, result)
|
|
})
|
|
}
|
|
}
|