SimpleTest: When using drupalGet to send the cookie, it's sending Cookie header twice, so the $_COOKIE is not valid

It doesn't return in header, but the URL which is called has access to cookie via $_COOKIE.

added question

updating the old issue with more investigation

removing repetition

changing cookie name

Related (libcurl):
https://sourceforge.net/tracker/?func=detail&atid=100976&aid=3513010&gro...

Reproducing the bug in simple way

Following script test the bug:

$ cat ./curl-test.drush
#!/usr/bin/env drush

require_once drupal_get_path('module', 'simpletest') . '/drupal_web_test_case.php';

class CurlTest extends DrupalWebTestCase {
  function testCurl() {
    // Create new user to create session cookie and log in
    $user = $this->drupalCreateUser(array('access content'));
    $this->drupalLogin($user);
    // Set up curl, so we can see the sent headers later
    $this->curlInitialize();
    curl_setopt($this->curlHandle, CURLINFO_HEADER_OUT, true);
    // Open any page
    $this->drupalGet('node', array(), array("Cookie: my_cookie"));
    // Print sent headers
    print_r(curl_getinfo($this->curlHandle, CURLINFO_HEADER_OUT));
  }
}

$test = new CurlTest();
$test->run();

It should give you something like:

GET /node HTTP/1.1
User-Agent: simpletest111843;1349265652;506c28f47bbb69.14132423;tMqlFGrpITeHbToprcbYZ59LOpQ=
Host: localhost
Accept: */*
Cookie: SESSd5f6d078ecfc43ac091312829e2f7ae5=e67c7c3cff2f6f3b22b34b176c9214aa
Cookie: my_cookie

Which is wrong (Cookie section has two lines, instead of one).
If additional session cookie is not generated by drush, try pasting somewhere else, i.e. Devel PHP Code.

Following patch fix the problem.
Tested on Drupal 6.x (Pressflow). Should be pretty the same for Drupal 7.x.

Now the testing code from #5 returns this:

GET /node HTTP/1.1
User-Agent: simpletest625291;1349267923;506c31d365eb87.60621687;RrdoinDNw96MlcoC9zbWM9/AmGI=
Host: localhost
Accept: */*
Cookie: SESSd5f6d078ecfc43ac091312829e2f7ae5=10f7d556b551084fb2dc5208cbfb6a6b; my_cookie

P.S. I'm behind the proxy, so I can't create the proper patch against the latest git version.

Workaround

As workaround (without patching) it's possible to defining own drupalGet method in the test.

  /**
   * Retrieves a Drupal path or an absolute path.
   *
   * @param $path
   *   Drupal path or URL to load into internal browser
   * @param $options
   *   Options to be forwarded to url().
   * @param $headers
   *   An array containing additional HTTP request headers, each formatted as
   *   "name: value".
   * @param $cookies
   *   The contents of the "Cookie: " header to be used in the HTTP request.
   *   Note that multiple cookies are separated with a semicolon followed by a space as
   *   "fruit=apple; colour=red".
   * @return
   *   The retrieved HTML string, also available as $this->drupalGetContent()
   */
  protected function drupalGet($path, array $options = array(), array $headers = array(), $cookies = '') {
    $options['absolute'] = TRUE;

    // We re-using a CURL connection here. If that connection still has certain
    // options set, it might change the GET into a POST. Make sure we clear out
    // previous options.
    $out = $this->curlExec(array(CURLOPT_HTTPGET => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_NOBODY => FALSE, CURLOPT_HTTPHEADER => $headers, CURLOPT_COOKIE => $cookies));
    $this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.

    // Replace original page output with new output from redirected page(s).
    if ($new = $this->checkForMetaRefresh()) {
      $out = $new;
    }
    $this->verbose('GET request to: ' . $path .
                   '<hr />Ending URL: ' . $this->getUrl() .
                   '<hr />' . $out);
    return $out;
  }

simplified cookie name

As per http://stackoverflow.com/questions/9142964/curl-cookie-value

You should use CURLOPT_COOKIE not CURLOPT_HTTPHEADER to set the cookie values sent in the request.

marking it as a feature.