Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 698e065e authored by Felipe Leme's avatar Felipe Leme Committed by Josh Gao
Browse files

DO NOT MERGE: Split bugreport() into its own file and added unit tests. 

bugreport() will be soon refactored to track progress, which will
require more comprehensive unit tests.

As such, it's better to move it to its own files, which in turn also
requires moving send_shell_command() and usage() to commandline.h.

Fixes: 30100363
Bug: 30268737

Change-Id: I3cdf114a0b5547293320042ff0749a60886440b0
(cherry picked from commit 78e0963e)
(cherry picked from commit 218e1ff7)
parent 248722e7

adb/Android.mk

+5 −0
Original line number Diff line number Diff line
@@ -184,6 +184,9 @@ LOCAL_CFLAGS_linux := $(LIBADB_linux_CFLAGS) 
LOCAL_CFLAGS_darwin := $(LIBADB_darwin_CFLAGS)

LOCAL_SRC_FILES := \

    $(LIBADB_TEST_SRCS) \

    adb_client.cpp \

    bugreport.cpp \

    bugreport_test.cpp \

    services.cpp \

    shell_service_protocol.cpp \

    shell_service_protocol_test.cpp \
@@ -199,6 +202,7 @@ LOCAL_STATIC_LIBRARIES := \ 
    libcrypto \

    libcutils \

    libdiagnose_usb \

    libgmock_host \



# Set entrypoint to wmain from sysdeps_win32.cpp instead of main

LOCAL_LDFLAGS_windows := -municode
@@ -227,6 +231,7 @@ LOCAL_REQUIRED_MODULES_windows := AdbWinApi AdbWinUsbApi 


LOCAL_SRC_FILES := \

    adb_client.cpp \

    bugreport.cpp \

    client/main.cpp \

    console.cpp \

    commandline.cpp \

adb/adb.h

+0 −2
Original line number Diff line number Diff line
@@ -203,8 +203,6 @@ void usb_kick(usb_handle *h); 
int is_adb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);

#endif



int adb_commandline(int argc, const char **argv);



ConnectionState connection_state(atransport *t);



extern const char* adb_device_banner;

adb/adb_client.h

+1 −0
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ 
#define _ADB_CLIENT_H_



#include "adb.h"

#include "sysdeps.h"

#include "transport.h"



#include <string>

adb/bugreport.cpp

0 → 100644
+80 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 The Android Open Source Project

 *

 * 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.

 */



#include <string>



#include <android-base/strings.h>



#include "bugreport.h"

#include "commandline.h"

#include "file_sync_service.h"



static constexpr char BUGZ_OK_PREFIX[] = "OK:";

static constexpr char BUGZ_FAIL_PREFIX[] = "FAIL:";



int Bugreport::DoIt(TransportType transport_type, const char* serial, int argc, const char** argv) {

    if (argc == 1) return SendShellCommand(transport_type, serial, "bugreport", false);

    if (argc != 2) return usage();



    // Zipped bugreport option - will call 'bugreportz', which prints the location

    // of the generated

    // file, then pull it to the destination file provided by the user.

    std::string dest_file = argv[1];

    if (!android::base::EndsWith(argv[1], ".zip")) {

        // TODO: use a case-insensitive comparison (like EndsWithIgnoreCase

        dest_file += ".zip";

    }

    std::string output;



    fprintf(stderr,

            "Bugreport is in progress and it could take minutes to complete.\n"

            "Please be patient and do not cancel or disconnect your device until "

            "it completes.\n");

    int status = SendShellCommand(transport_type, serial, "bugreportz", false, &output, nullptr);

    if (status != 0 || output.empty()) return status;

    output = android::base::Trim(output);



    if (android::base::StartsWith(output, BUGZ_OK_PREFIX)) {

        const char* zip_file = &output[strlen(BUGZ_OK_PREFIX)];

        std::vector<const char*> srcs{zip_file};

        status = DoSyncPull(srcs, dest_file.c_str(), true, dest_file.c_str()) ? 0 : 1;

        if (status != 0) {

            fprintf(stderr, "Could not copy file '%s' to '%s'\n", zip_file, dest_file.c_str());

        }

        return status;

    }

    if (android::base::StartsWith(output, BUGZ_FAIL_PREFIX)) {

        const char* error_message = &output[strlen(BUGZ_FAIL_PREFIX)];

        fprintf(stderr, "Device failed to take a zipped bugreport: %s\n", error_message);

        return -1;

    }

    fprintf(stderr,

            "Unexpected string (%s) returned by bugreportz, "

            "device probably does not support it\n",

            output.c_str());

    return -1;

}



int Bugreport::SendShellCommand(TransportType transport_type, const char* serial,

                                const std::string& command, bool disable_shell_protocol,

                                std::string* output, std::string* err) {

    return send_shell_command(transport_type, serial, command, disable_shell_protocol, output, err);

}



bool Bugreport::DoSyncPull(const std::vector<const char*>& srcs, const char* dst, bool copy_attrs,

                           const char* name) {

    return do_sync_pull(srcs, dst, copy_attrs, name);

}

adb/bugreport.h

0 → 100644
+44 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 The Android Open Source Project

 *

 * 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.

 */



#ifndef BUGREPORT_H

#define BUGREPORT_H



#include <vector>



#include "adb.h"



class Bugreport {

  public:

    Bugreport() {

    }

    int DoIt(TransportType transport_type, const char* serial, int argc, const char** argv);



  protected:

    // Functions below are abstractions of external functions so they can be

    // mocked on tests.

    virtual int SendShellCommand(TransportType transport_type, const char* serial,

                                 const std::string& command, bool disable_shell_protocol,

                                 std::string* output = nullptr, std::string* err = nullptr);



    virtual bool DoSyncPull(const std::vector<const char*>& srcs, const char* dst, bool copy_attrs,

                            const char* name);



  private:

    DISALLOW_COPY_AND_ASSIGN(Bugreport);

};



#endif  // BUGREPORT_H