feat(GH-42): Result filename starts with the pod name (#45)

Author: josepdcs

internal/cli/adapter/profiling_container_adapter.go

@@ -127,7 +127,7 @@ func (p profilingContainerAdapter) GetRemoteFile(pod *v1.Pod, containerName stri
 		return "", errors.Wrap(err, "could not decode remote file")
 	}
 
-	fileName := filepath.Join(target.LocalPath, renameResultFileName(remoteFile.FileName, remoteFile.Timestamp))
+	fileName := filepath.Join(target.LocalPath, renameResultFileName(target.PodName, remoteFile.FileName, remoteFile.Timestamp))
 
 	err = os.WriteFile(fileName, decoded, 0644)
 	if err != nil {
@@ -275,9 +275,9 @@ func readChunks(downloadChunks []string, fileBuffSize int64) ([]byte, error) {
 }
 
 // renameResultFileName renames the result file
-func renameResultFileName(fileName string, t time.Time) string {
+func renameResultFileName(podName, fileName string, t time.Time) string {
 	f := stringUtils.SubstringBeforeLast(stringUtils.SubstringAfterLast(fileName, "/"), ".")
-	return stringUtils.SubstringBefore(f, ".") + "-" + strings.ReplaceAll(t.Format(time.RFC3339), ":", "_") + "." + stringUtils.SubstringAfter(f, ".")
+	return podName + "-" + stringUtils.SubstringBefore(f, ".") + "-" + strings.ReplaceAll(t.Format(time.RFC3339), ":", "_") + "." + stringUtils.SubstringAfter(f, ".")
 }
 
 // renameChunkFileName renames the chunk file

internal/cli/adapter/profiling_container_adapter_test.go

@@ -171,14 +171,15 @@ func Test_profilingContainerAdapter_HandleProfilingContainerLogs(t *testing.T) {
 
 func Test_renameResultFileName(t *testing.T) {
 	// Given
-	fileName := "/tmp/contprof-flamegraph.svg.gz"
+	podName := "pod-name"
+	fileName := "/tmp/flamegraph.svg.gz"
 	timestamp, _ := time.Parse(time.RFC3339, "2023-02-28T11:44:12.678378359Z")
 
 	// When
-	result := renameResultFileName(fileName, timestamp)
+	result := renameResultFileName(podName, fileName, timestamp)
 
 	// Then
-	assert.Equal(t, "contprof-flamegraph-2023-02-28T11_44_12Z.svg", result)
+	assert.Equal(t, "pod-name-flamegraph-2023-02-28T11_44_12Z.svg", result)
 }
 
 func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
@@ -251,6 +252,7 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 						target: &config.TargetConfig{
 							LocalPath:  "/tmp",
 							Compressor: compressor.None,
+							PodName:    "pod-name",
 						},
 					}
 			},
@@ -263,10 +265,10 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 			},
 			then: func(t *testing.T, r result, f fields) {
 				require.NoError(t, r.err)
-				assert.Equal(t, filepath.Join(common.TmpDir(), "flamegraph-2023-02-28T11_44_12Z.svg"), r.remoteFile)
+				assert.Equal(t, filepath.Join(common.TmpDir(), "pod-name-flamegraph-2023-02-28T11_44_12Z.svg"), r.remoteFile)
 			},
 			afterEach: func() {
-				_ = os.Remove(filepath.Join(common.TmpDir(), "flamegraph-2023-02-28T11_44_12Z.svg"))
+				_ = os.Remove(filepath.Join(common.TmpDir(), "pod-name-flamegraph-2023-02-28T11_44_12Z.svg"))
 			},
 		},
 		{
@@ -567,6 +569,7 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 						target: &config.TargetConfig{
 							LocalPath:  "/other",
 							Compressor: compressor.None,
+							PodName:    "pod-name",
 						},
 					}
 			},
@@ -579,7 +582,7 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 			},
 			then: func(t *testing.T, r result, f fields) {
 				require.Error(t, r.err)
-				assert.EqualError(t, r.err, "could not write result file: open /other/flamegraph-2023-02-28T11_44_12Z.svg: no such file or directory")
+				assert.EqualError(t, r.err, "could not write result file: open /other/pod-name-flamegraph-2023-02-28T11_44_12Z.svg: no such file or directory")
 			},
 		},
 		{
@@ -636,6 +639,7 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 						target: &config.TargetConfig{
 							LocalPath:  "/tmp",
 							Compressor: compressor.None,
+							PodName:    "pod-name",
 						},
 					}
 			},
@@ -648,10 +652,10 @@ func Test_profilingContainerAdapter_GetRemoteFile(t *testing.T) {
 			},
 			then: func(t *testing.T, r result, f fields) {
 				require.NoError(t, r.err)
-				assert.Equal(t, filepath.Join(common.TmpDir(), "flamegraph-2023-02-28T11_44_12Z.svg"), r.remoteFile)
+				assert.Equal(t, filepath.Join(common.TmpDir(), "pod-name-flamegraph-2023-02-28T11_44_12Z.svg"), r.remoteFile)
 			},
 			afterEach: func() {
-				_ = os.Remove(filepath.Join(common.TmpDir(), "flamegraph-2023-02-28T11_44_12Z.svg"))
+				_ = os.Remove(filepath.Join(common.TmpDir(), "pod-name-flamegraph-2023-02-28T11_44_12Z.svg"))
 			},
 		},
 		{

internal/cli/profiler/job_profiler.go

@@ -29,7 +29,7 @@ func NewJobProfiler(podAdapter adapter.PodAdapter, profilingJobAdapter adapter.P
 	}
 }
 
-// Profile runs all the steps of the profiling from the job creation up to obtain the profiling result
+// Profile runs all the steps of the profiling from the job creation up to get the profiling result
 func (p JobProfiler) Profile(cfg *config.ProfilerConfig) error {
 	ctx := context.Background()