PCBC-745: Add test coverage for *Options->cas() argument

Change-Id: I53e80967ebe13afc8c52304418e0f2967a8abff4
Reviewed-on: http://review.couchbase.org/c/php-couchbase/+/147745
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

api/couchbase.php

@@ -3701,16 +3701,6 @@ public function expiry(mixed $arg): UpsertOptions
         {
         }
 
-        /**
-         * Sets the cas value for the operation.
-         *
-         * @param string $arg the cas value
-         * @return UpsertOptions
-         */
-        public function cas(string $arg): UpsertOptions
-        {
-        }
-
         /**
          * Sets the durability level to enforce when writing the document.
          *

src/couchbase/bucket/remove.c

@@ -85,10 +85,12 @@ PHP_METHOD(RemoveOptions, cas)
         RETURN_NULL();
     }
     zend_string *decoded = php_base64_decode_str(arg);
+    if (decoded && ZSTR_LEN(decoded) == sizeof(uint64_t)) {
+        pcbc_update_property_str(pcbc_remove_options_ce, getThis(), ("cas"), arg);
+    } else {
+        throw_lcb_exception(LCB_ERR_INVALID_ARGUMENT, NULL);
+    }
     if (decoded) {
-        if (ZSTR_LEN(decoded) == sizeof(uint64_t)) {
-            pcbc_update_property_str(pcbc_remove_options_ce, getThis(), ("cas"), arg);
-        }
         zend_string_free(decoded);
     }
     RETURN_ZVAL(getThis(), 1, 0);

src/couchbase/bucket/store.c

@@ -259,21 +259,8 @@ zend_class_entry *pcbc_upsert_options_ce;
 
 PHP_METHOD(UpsertOptions, cas)
 {
-    zend_string *arg;
-    int rv = zend_parse_parameters_throw(ZEND_NUM_ARGS(), "S", &arg);
-    if (rv == FAILURE) {
-        RETURN_NULL();
-    }
-    zend_string *decoded = php_base64_decode_str(arg);
-    if (decoded && ZSTR_LEN(decoded) == sizeof(uint64_t)) {
-        pcbc_update_property_str(pcbc_upsert_options_ce, getThis(), ("cas"), arg);
-    } else {
-        throw_lcb_exception(LCB_ERR_INVALID_ARGUMENT, NULL);
-    }
-    if (decoded) {
-        zend_string_free(decoded);
-    }
-    RETURN_ZVAL(getThis(), 1, 0);
+    zend_parse_parameters_none_throw();
+    RETURN_NULL();
 }
 
 PHP_METHOD(UpsertOptions, timeout)
@@ -343,7 +330,7 @@ ZEND_END_ARG_INFO()
 
 // clang-format off
 static const zend_function_entry pcbc_upsert_options_methods[] = {
-    PHP_ME(UpsertOptions, cas, ai_UpsertOptions_cas, ZEND_ACC_PUBLIC)
+    PHP_ME(UpsertOptions, cas, ai_UpsertOptions_cas, ZEND_ACC_PUBLIC|ZEND_ACC_DEPRECATED)
     PHP_ME(UpsertOptions, timeout, ai_UpsertOptions_timeout, ZEND_ACC_PUBLIC)
     PHP_ME(UpsertOptions, expiry, ai_UpsertOptions_expiry, ZEND_ACC_PUBLIC)
     PHP_ME(UpsertOptions, durabilityLevel, ai_UpsertOptions_durabilityLevel, ZEND_ACC_PUBLIC)

src/couchbase/bucket/subdoc.c

@@ -336,10 +336,12 @@ PHP_METHOD(MutateInOptions, cas)
         RETURN_NULL();
     }
     zend_string *decoded = php_base64_decode_str(arg);
+    if (decoded && ZSTR_LEN(decoded) == sizeof(uint64_t)) {
+        pcbc_update_property_str(pcbc_mutate_in_options_ce, getThis(), ("cas"), arg);
+    } else {
+        throw_lcb_exception(LCB_ERR_INVALID_ARGUMENT, NULL);
+    }
     if (decoded) {
-        if (ZSTR_LEN(decoded) == sizeof(uint64_t)) {
-            pcbc_update_property_str(pcbc_mutate_in_options_ce, getThis(), ("cas"), arg);
-        }
         zend_string_free(decoded);
     }
     RETURN_ZVAL(getThis(), 1, 0);

tests/BucketTest.php

@@ -5,9 +5,11 @@
 use \Couchbase\ClusterOptions;
 use \Couchbase\GetOptions;
 use \Couchbase\UpsertOptions;
+use \Couchbase\ReplaceOptions;
+use \Couchbase\RemoveOptions;
+use \Couchbase\MutateInOptions;
 
 class BucketTest extends CouchbaseTestCase {
-
     /**
      * Test that connections with invalid details fail.
      */
@@ -79,6 +81,45 @@ function testBasicGet($c, $key) {
         return $key;
     }
 
+    /**
+     * Verifies that library-generated CAS values work as expected
+     *
+     * @depends testConnect
+     */
+    function testGoodCas($c) {
+        $key = $this->makeKey('goodCas');
+
+        $res = $c->upsert($key, ['name' => 'bob']);
+        $this->assertNotNull($res->cas());
+        $cas1 = $res->cas();
+        var_dump($res->cas());
+
+        $options = new ReplaceOptions();
+        $options->cas($cas1);
+        $res = $c->replace($key, ['name' => 'john'], $options);
+        $this->assertNotNull($res->cas());
+        $cas2 = $res->cas();
+        $this->assertNotEquals($cas1, $cas2);
+
+        $res = $c->get($key);
+        $this->assertEquals($cas2, $res->cas());
+        $this->assertEquals($res->content(), ['name' => 'john']);
+    }
+
+    function testBadCas() {
+        // strings are not CAS
+        $options = new RemoveOptions();
+        $this->wrapException(function() use($options) {
+            $options->cas("0xdeadbeef");
+        }, '\Couchbase\BadInputException');
+
+        // Application should not attempt to generate CAS literals
+        $options = new MutateInOptions();
+        $this->wrapException(function() use($options) {
+            $options->cas("776t3g==");
+        }, '\Couchbase\BadInputException');
+    }
+
     /**
      * Test reaction on empty value
      *