forked from elastic/elastic-agent
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
diagnostics creates the necessary folder for -f argumen (elastic#3340)
- makes diagnostics command to create the necessary folders when a custom path is provided by the '-f' flag. - refactors the diagnosticCmd splitting it into smaller functions - add test createFile - rename logs_test.go createFile function to createFileEmpty so its name wont collide with the newly created 'createFile' function. add license headaer
- Loading branch information
Showing
4 changed files
with
143 additions
and
33 deletions.
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
...gelog/fragments/1693544911-Diagnostics-command-creates-necessary-folders-for--f-flag.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Kind can be one of: | ||
# - breaking-change: a change to previously-documented behavior | ||
# - deprecation: functionality that is being removed in a later release | ||
# - bug-fix: fixes a problem in a previous version | ||
# - enhancement: extends functionality but does not break or fix existing behavior | ||
# - feature: new functionality | ||
# - known-issue: problems that we are aware of in a given version | ||
# - security: impacts on the security of a product or a user’s deployment. | ||
# - upgrade: important information for someone upgrading from a prior version | ||
# - other: does not fit into any of the other categories | ||
kind: bug | ||
|
||
# Change summary; a 80ish characters long description of the change. | ||
summary: Diagnostics command creates necessary folders for -f flag | ||
|
||
# Long description; in case the summary is not enough to describe the change | ||
# this field accommodate a description without length limits. | ||
# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment. | ||
#description: | ||
|
||
# Affected component; a word indicating the component this changeset affects. | ||
component: diagnostics command | ||
|
||
# PR URL; optional; the PR number that added the changeset. | ||
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added. | ||
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number. | ||
# Please provide it if you are adding a fragment for a different PR. | ||
#pr: https://github.com/owner/repo/1234 | ||
|
||
# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of). | ||
# If not present is automatically filled by the tooling with the issue linked to the PR number. | ||
#issue: https://github.com/owner/repo/1234 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
// or more contributor license agreements. Licensed under the Elastic License; | ||
// you may not use this file except in compliance with the Elastic License. | ||
|
||
package cmd | ||
|
||
import ( | ||
"os" | ||
"path" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func Test_createFile(t *testing.T) { | ||
dir := t.TempDir() | ||
existingFile := "existingfile.zip" | ||
f, err := os.Create(path.Join(dir, "existingFile")) | ||
require.NoErrorf(t, err, "could not create file %q", path.Join(dir, "existingFile")) | ||
err = f.Close() | ||
require.NoError(t, err, "could not close file") | ||
|
||
testCases := []struct { | ||
name string | ||
filePath string | ||
}{ | ||
{ | ||
name: "ExistingFile", | ||
filePath: path.Join(dir, existingFile), | ||
}, | ||
{ | ||
name: "NewFile", | ||
filePath: path.Join(dir, "newfile.zip"), | ||
}, | ||
{ | ||
name: "NonexistentFolders", | ||
filePath: path.Join(dir, "nonexistent", "folders", "file.zip"), | ||
}, | ||
} | ||
|
||
for _, tc := range testCases { | ||
t.Run(tc.name, func(t *testing.T) { | ||
file, err := createFile(tc.filePath) | ||
require.NoError(t, err, "failed creating diagnostics file %q", | ||
tc.filePath) | ||
defer func() { | ||
file.Close() | ||
}() | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters