aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/com/google/android/mobly/snippet/bundled/NetworkingSnippet.java
blob: 636c0fdbbf5829f8e1e956ebdedc1abb7ffc10d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (C) 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.android.mobly.snippet.bundled;

import android.app.DownloadManager;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.net.Uri;
import android.os.Environment;
import androidx.test.platform.app.InstrumentationRegistry;
import com.google.android.mobly.snippet.Snippet;
import com.google.android.mobly.snippet.bundled.utils.Utils;
import com.google.android.mobly.snippet.rpc.Rpc;
import com.google.android.mobly.snippet.util.Log;
import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;
import java.net.UnknownHostException;
import java.util.List;
import java.util.Locale;

/** Snippet class for networking RPCs. */
public class NetworkingSnippet implements Snippet {

    private final Context mContext;
    private final DownloadManager mDownloadManager;
    private volatile boolean mIsDownloadComplete = false;
    private volatile long mReqid = 0;

    public NetworkingSnippet() {
        mContext = InstrumentationRegistry.getInstrumentation().getContext();
        mDownloadManager = (DownloadManager) mContext.getSystemService(Context.DOWNLOAD_SERVICE);
    }

    private static class NetworkingSnippetException extends Exception {

        private static final long serialVersionUID = 8080L;

        public NetworkingSnippetException(String msg) {
            super(msg);
        }
    }

    @Rpc(description = "Check if a host and port are connectable using a TCP connection attempt.")
    public boolean networkIsTcpConnectable(String host, int port) {
        InetAddress addr;
        try {
            addr = InetAddress.getByName(host);
        } catch (UnknownHostException uherr) {
            Log.d("Host name lookup failure: " + uherr.getMessage());
            return false;
        }

        try {
            Socket sock = new Socket(addr, port);
            sock.close();
        } catch (IOException ioerr) {
            Log.d("Did not make connection to host: " + ioerr.getMessage());
            return false;
        }
        return true;
    }

    @Rpc(
            description =
                    "Download a file using HTTP. Return content Uri (file remains on device). "
                            + "The Uri should be treated as an opaque handle for further operations.")
    public String networkHttpDownload(String url)
            throws IllegalArgumentException, NetworkingSnippetException {

        Uri uri = Uri.parse(url);
        List<String> pathsegments = uri.getPathSegments();
        if (pathsegments.size() < 1) {
            throw new IllegalArgumentException(
                    String.format(Locale.US, "The Uri %s does not have a path.", uri.toString()));
        }
        DownloadManager.Request request = new DownloadManager.Request(uri);
        request.setDestinationInExternalPublicDir(
                Environment.DIRECTORY_DOWNLOADS, pathsegments.get(pathsegments.size() - 1));
        mIsDownloadComplete = false;
        mReqid = 0;
        IntentFilter filter = new IntentFilter(DownloadManager.ACTION_DOWNLOAD_COMPLETE);
        BroadcastReceiver receiver = new DownloadReceiver();
        mContext.registerReceiver(receiver, filter);
        try {
            mReqid = mDownloadManager.enqueue(request);
            Log.d(
                    String.format(
                            Locale.US,
                            "networkHttpDownload download of %s with id %d",
                            url,
                            mReqid));
            if (!Utils.waitUntil(() -> mIsDownloadComplete, 30)) {
                Log.d(
                        String.format(
                                Locale.US, "networkHttpDownload timed out waiting for completion"));
                throw new NetworkingSnippetException("networkHttpDownload timed out.");
            }
        } finally {
            mContext.unregisterReceiver(receiver);
        }
        Uri resp = mDownloadManager.getUriForDownloadedFile(mReqid);
        if (resp != null) {
            Log.d(String.format(Locale.US, "networkHttpDownload completed to %s", resp.toString()));
            mReqid = 0;
            return resp.toString();
        } else {
            Log.d(
                    String.format(
                            Locale.US,
                            "networkHttpDownload Failed to download %s",
                            uri.toString()));
            throw new NetworkingSnippetException("networkHttpDownload didn't get downloaded file.");
        }
    }

    private class DownloadReceiver extends BroadcastReceiver {

        @Override
        public void onReceive(Context context, Intent intent) {
            String action = intent.getAction();
            long gotid = (long) intent.getExtras().get("extra_download_id");
            if (DownloadManager.ACTION_DOWNLOAD_COMPLETE.equals(action) && gotid == mReqid) {
                mIsDownloadComplete = true;
            }
        }
    }

    @Override
    public void shutdown() {
        if (mReqid != 0) {
            mDownloadManager.remove(mReqid);
        }
    }
}