Blame SOURCES/0242-dd-introduce-dd_get_env_variable.patch

4b6aa8
From af5ef029fe96a8703a1de7a60063c473d17d37a4 Mon Sep 17 00:00:00 2001
4b6aa8
From: Martin Kutlak <mkutlak@redhat.com>
4b6aa8
Date: Tue, 21 May 2019 10:45:55 +0200
4b6aa8
Subject: [PATCH] dd: introduce dd_get_env_variable
4b6aa8
4b6aa8
I was thinking about adding 'dd_open_element' function returning file
4b6aa8
descriptor but I thrown this idea because we should try to hide
4b6aa8
implementation details and do not let users to parse elements on their
4b6aa8
own.
4b6aa8
4b6aa8
Cherry-picked from https://github.com/abrt/libreport/commit/a1d7a0397b8251be58783dd5e8665099bf8ce868
4b6aa8
---
4b6aa8
 src/include/dump_dir.h | 11 +++++++++++
4b6aa8
 src/lib/dump_dir.c     | 11 +++++++++++
4b6aa8
 tests/dump_dir.at      | 31 +++++++++++++++++++++++++++++++
4b6aa8
 3 files changed, 53 insertions(+)
4b6aa8
4b6aa8
diff --git a/src/include/dump_dir.h b/src/include/dump_dir.h
4b6aa8
index b617c6c..a7ed431 100644
4b6aa8
--- a/src/include/dump_dir.h
4b6aa8
+++ b/src/include/dump_dir.h
4b6aa8
@@ -118,6 +118,17 @@ int dd_get_next_file(struct dump_dir *dd, char **short_name, char **full_name);
4b6aa8
 
4b6aa8
 char* dd_load_text_ext(const struct dump_dir *dd, const char *name, unsigned flags);
4b6aa8
 char* dd_load_text(const struct dump_dir *dd, const char *name);
4b6aa8
+
4b6aa8
+/* Returns value of environment variable with given name.
4b6aa8
+ *
4b6aa8
+ * @param dd Dump directory
4b6aa8
+ * @param name Variables's name
4b6aa8
+ * @param value Return value.
4b6aa8
+ * @return 0 no success, or negative value if an error occurred (-ENOENT if the
4b6aa8
+ * given dd does not support environment variables).
4b6aa8
+ */
4b6aa8
+int dd_get_env_variable(struct dump_dir *dd, const char *name, char **value);
4b6aa8
+
4b6aa8
 void dd_save_text(struct dump_dir *dd, const char *name, const char *data);
4b6aa8
 void dd_save_binary(struct dump_dir *dd, const char *name, const char *data, unsigned size);
4b6aa8
 int dd_copy_file(struct dump_dir *dd, const char *name, const char *source_path);
4b6aa8
diff --git a/src/lib/dump_dir.c b/src/lib/dump_dir.c
4b6aa8
index 5e32c08..0da96cd 100644
4b6aa8
--- a/src/lib/dump_dir.c
4b6aa8
+++ b/src/lib/dump_dir.c
4b6aa8
@@ -1242,6 +1242,17 @@ char* dd_load_text(const struct dump_dir *dd, const char *name)
4b6aa8
     return dd_load_text_ext(dd, name, /*flags:*/ 0);
4b6aa8
 }
4b6aa8
 
4b6aa8
+int dd_get_env_variable(struct dump_dir *dd, const char *name, char **value)
4b6aa8
+{
4b6aa8
+    const int fd = openat(dd->dd_fd, FILENAME_ENVIRON, O_RDONLY | O_NOFOLLOW);
4b6aa8
+    if (fd < 0)
4b6aa8
+        return -errno;
4b6aa8
+
4b6aa8
+    const int r  = get_env_variable_ext(fd, '\n', name, value);
4b6aa8
+    close(fd);
4b6aa8
+    return r;
4b6aa8
+}
4b6aa8
+
4b6aa8
 void dd_save_text(struct dump_dir *dd, const char *name, const char *data)
4b6aa8
 {
4b6aa8
     if (!dd->locked)
4b6aa8
diff --git a/tests/dump_dir.at b/tests/dump_dir.at
4b6aa8
index 98d564c..12a0c5c 100644
4b6aa8
--- a/tests/dump_dir.at
4b6aa8
+++ b/tests/dump_dir.at
4b6aa8
@@ -615,3 +615,34 @@ int main(int argc, char **argv)
4b6aa8
     return 0;
4b6aa8
 }
4b6aa8
 ]])
4b6aa8
+## ------------------- ##
4b6aa8
+## dd_get_env_variable ##
4b6aa8
+## ------------------- ##
4b6aa8
+
4b6aa8
+AT_TESTFUN([dd_get_env_variable],
4b6aa8
+[[
4b6aa8
+#include "testsuite.h"
4b6aa8
+#include "testsuite_tools.h"
4b6aa8
+
4b6aa8
+TS_MAIN
4b6aa8
+{
4b6aa8
+    struct dump_dir *dd = testsuite_dump_dir_create(-1, -1, 0);
4b6aa8
+
4b6aa8
+    dd_create_basic_files(dd, geteuid(), NULL);
4b6aa8
+
4b6aa8
+    char *value = NULL;
4b6aa8
+    TS_ASSERT_SIGNED_EQ(dd_get_env_variable(dd, "FROG", &value), -ENOENT);
4b6aa8
+    TS_ASSERT_PTR_IS_NULL_MESSAGE(value, "Untouched return value on -ENOENT");
4b6aa8
+
4b6aa8
+    dd_save_text(dd, FILENAME_ENVIRON, "FROG=ribbit\nROOSTER=cockle-doodle-doo");
4b6aa8
+
4b6aa8
+    TS_ASSERT_FUNCTION(dd_get_env_variable(dd, "HORSE", &value));
4b6aa8
+    TS_ASSERT_PTR_IS_NULL_MESSAGE(value, "Untouched return value on missing variable");
4b6aa8
+
4b6aa8
+    TS_ASSERT_FUNCTION(dd_get_env_variable(dd, "ROOSTER", &value));
4b6aa8
+    TS_ASSERT_STRING_EQ(value, "cockle-doodle-doo", "Variable ROOSTER loaded from the dump dir");
4b6aa8
+
4b6aa8
+    testsuite_dump_dir_delete(dd);
4b6aa8
+}
4b6aa8
+TS_RETURN_MAIN
4b6aa8
+]])
4b6aa8
-- 
4b6aa8
2.21.0
4b6aa8