update_engine: Make the ChromeOS/AOSP Omaha Client transmit requestid.
As per Omaha's protocol specification, ChromeOS/AOSP
needs to transmit the 'requestid` attribute in the request.
The format of the 'requestid' attribute is sent as GUID version 4.
This change will add the 'requestid' attribute in the omaha request.
BUG=chromium:940505
TEST=cros_workon_make --board=octopus update_engine --test
TEST=/usr/bin/update_engine_client --check_for_update # after bouncing
update-engine + check /var/log/update_engine.log. 'requestid'
attribute will be in the omaha request.
Change-Id: I76f1fe82d1e976b5316b4af9148097f1266dea91
Reviewed-on: https://chromium-review.googlesource.com/1653709
Tested-by: Jae Hoon Kim <kimjae@chromium.org>
Commit-Ready: Jae Hoon Kim <kimjae@chromium.org>
Legacy-Commit-Queue: Commit Bot <commit-bot@chromium.org>
Reviewed-by: Amin Hassani <ahassani@chromium.org>
diff --git a/omaha_request_builder_xml.cc b/omaha_request_builder_xml.cc
index ad7c424..e335c40 100644
--- a/omaha_request_builder_xml.cc
+++ b/omaha_request_builder_xml.cc
@@ -20,6 +20,7 @@
#include <string>
+#include <base/guid.h>
#include <base/logging.h>
#include <base/strings/string_number_conversions.h>
#include <base/strings/string_util.h>
@@ -336,8 +337,10 @@
string request_xml = base::StringPrintf(
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
- "<request protocol=\"3.0\" updater=\"%s\" updaterversion=\"%s\""
+ "<request requestid=\"%s\""
+ " protocol=\"3.0\" updater=\"%s\" updaterversion=\"%s\""
" installsource=\"%s\" ismachine=\"1\">\n%s%s</request>\n",
+ base::GenerateGUID().c_str() /* requestid */,
constants::kOmahaUpdaterID,
kOmahaUpdaterVersion,
params_->interactive() ? "ondemandupdate" : "scheduler",
diff --git a/omaha_request_builder_xml_unittest.cc b/omaha_request_builder_xml_unittest.cc
index 5c37571..23abebb 100644
--- a/omaha_request_builder_xml_unittest.cc
+++ b/omaha_request_builder_xml_unittest.cc
@@ -20,15 +20,40 @@
#include <utility>
#include <vector>
+#include <base/guid.h>
#include <gtest/gtest.h>
+#include "update_engine/fake_system_state.h"
+
using std::pair;
using std::string;
using std::vector;
namespace chromeos_update_engine {
-class OmahaRequestBuilderXmlTest : public ::testing::Test {};
+namespace {
+// Helper to find key and extract value from the given string |xml|, instead
+// of using a full parser. The attribute key will be followed by "=\"" as xml
+// attribute values must be within double quotes (not single quotes).
+static string FindAttributeKeyValueInXml(const string& xml,
+ const string& key,
+ const size_t val_size) {
+ string key_with_quotes = key + "=\"";
+ const size_t val_start_pos = xml.find(key);
+ if (val_start_pos == string::npos)
+ return "";
+ return xml.substr(val_start_pos + key_with_quotes.size(), val_size);
+}
+} // namespace
+
+class OmahaRequestBuilderXmlTest : public ::testing::Test {
+ protected:
+ void SetUp() override {}
+ void TearDown() override {}
+
+ FakeSystemState fake_system_state_;
+ static constexpr size_t kGuidSize = 36;
+};
TEST_F(OmahaRequestBuilderXmlTest, XmlEncodeTest) {
string output;
@@ -55,4 +80,24 @@
EXPECT_EQ("<not escaped>", XmlEncodeWithDefault("\xc2", "<not escaped>"));
}
+TEST_F(OmahaRequestBuilderXmlTest, GetRequestXmlRequestIdTest) {
+ OmahaEvent omaha_event;
+ OmahaRequestParams omaha_request_params{&fake_system_state_};
+ OmahaRequestBuilderXml omaha_request{&omaha_event,
+ &omaha_request_params,
+ false,
+ false,
+ 0,
+ 0,
+ 0,
+ fake_system_state_.prefs()};
+ const string request_xml = omaha_request.GetRequest();
+ const string key = "requestid";
+ const string request_id =
+ FindAttributeKeyValueInXml(request_xml, key, kGuidSize);
+ // A valid |request_id| is either a GUID version 4 or empty string.
+ if (!request_id.empty())
+ EXPECT_TRUE(base::IsValidGUID(request_id));
+}
+
} // namespace chromeos_update_engine
