bigquery: loudly report invalid operations on dryruns (googleapis#2772)

Fixes googleapis#2479.
sag7777 · Jan 16, 2018 · d629d3e · d629d3e
1 parent 3448564
commit d629d3e
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryImpl.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryImpl.java
@@ -596,6 +596,7 @@ public TableResult query(QueryJobConfiguration configuration, JobOption... optio
   @Override
   public TableResult query(QueryJobConfiguration configuration, JobId jobId, JobOption... options)
       throws InterruptedException, JobException {
+    Job.checkNotDryRun(configuration, "query");
     return create(JobInfo.of(jobId, configuration), options).getQueryResults();
   }
 

diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Job.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Job.java
@@ -165,6 +165,7 @@ public Job build() {
    * @throws BigQueryException upon failure
    */
   public boolean exists() {
+    checkNotDryRun("exists");
     return bigquery.getJob(getJobId(), JobOption.fields()) != null;
   }
 
@@ -185,6 +186,7 @@ public boolean exists() {
    * @throws BigQueryException upon failure
    */
   public boolean isDone() {
+    checkNotDryRun("isDone");
     Job job = bigquery.getJob(getJobId(), JobOption.fields(BigQuery.JobField.STATUS));
     return job == null || job.getStatus().getState() == JobStatus.State.DONE;
   }
@@ -231,6 +233,7 @@ public boolean isDone() {
    *     to complete
    */
   public Job waitFor(RetryOption... waitOptions) throws InterruptedException {
+    checkNotDryRun("waitFor");
     Object completedJobResponse;
     if (getConfiguration().getType() == Type.QUERY) {
       completedJobResponse =
@@ -268,6 +271,7 @@ public Job waitFor(RetryOption... waitOptions) throws InterruptedException {
    */
   public TableResult getQueryResults(QueryResultsOption... options)
       throws InterruptedException, JobException {
+    checkNotDryRun("getQueryResults");
     if (getConfiguration().getType() != Type.QUERY) {
       throw new UnsupportedOperationException(
           "Getting query results is supported only for " + Type.QUERY + " jobs");
@@ -389,6 +393,7 @@ public boolean shouldRetry(Throwable prevThrowable, Job prevResponse) {
    * @throws BigQueryException upon failure
    */
   public Job reload(JobOption... options) {
+    checkNotDryRun("reload");
     return bigquery.getJob(getJobId(), options);
   }
 
@@ -410,9 +415,36 @@ public Job reload(JobOption... options) {
    * @throws BigQueryException upon failure
    */
   public boolean cancel() {
+    checkNotDryRun("cancel");
     return bigquery.cancel(getJobId());
   }
 
+  private void checkNotDryRun(String op) {
+    checkNotDryRun(getConfiguration(), op);
+  }
+
+  static void checkNotDryRun(JobConfiguration jobConfig, String op) {
+    QueryJobConfiguration config;
+    if (jobConfig instanceof QueryJobConfiguration) {
+      config = (QueryJobConfiguration) jobConfig;
+    } else {
+      return;
+    }
+
+    Boolean dryRun = config.dryRun();
+    if (dryRun == null) {
+      dryRun = false;
+    }
+    if (dryRun) {
+      String msg =
+          "Operation \"%s\" does not work for dryrun queries, "
+              + "since a dry run does not actually create a job. "
+              + "To validate a query and obtain some processing statistics, consider calling "
+              + "BigQuery.create(JobInfo).";
+      throw new UnsupportedOperationException(String.format(msg, op));
+    }
+  }
+
   /** Returns the job's {@code BigQuery} object used to issue requests. */
   public BigQuery getBigQuery() {
     return bigquery;

diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/BigQueryImplTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/BigQueryImplTest.java
@@ -1400,4 +1400,17 @@ public void testRuntimeException() {
     thrown.expectMessage(exceptionMessage);
     bigquery.getDataset(DATASET);
   }
+
+  @Test
+  public void testQueryDryRun() throws Exception {
+    // https://github.com/GoogleCloudPlatform/google-cloud-java/issues/2479
+    EasyMock.replay(bigqueryRpcMock);
+    thrown.expect(UnsupportedOperationException.class);
+    options
+        .toBuilder()
+        .setRetrySettings(ServiceOptions.getDefaultRetrySettings())
+        .build()
+        .getService()
+        .query(QueryJobConfiguration.newBuilder("foo").setDryRun(true).build());
+  }
 }