CN117472729A - Automatic test system of general API - Google Patents

Abstract

The invention provides a universal API automatic test system, which comprises a user interface, an executor, an execution configuration library, a connection configuration library, a scheme library, a use case library and a file system, wherein the user interface is used for executing the execution configuration; the user interface is responsible for acting interaction instructions from a user on an executor, an execution configuration, a connection configuration library, a scheme library, a use case library and a file system; and the state and result of the actuator are fed back to the user interface; the executor depends on a use case library, a connection configuration library, a scheme library and an execution configuration; the executor performs bidirectional data interaction with the target equipment; the executor responds to the control instruction of the user interface and feeds back the state and the execution result in the execution process to the user interface; the executor durably stores the state in the execution process and the execution result into a file system; executing a behavior configured to configure an actuator; the schema library depends on the use case library. The invention has the advantages of easy operation, strong universality, strong compatibility, easy debugging and high test efficiency.

Description

Automatic test system of general API

Technical Field

The invention relates to the technical field of wireless communication, in particular to a universal API automatic test system.

Background

There are many methods of performing API testing, such as writing specific test scripts (e.g., python scripts, shell scripts, etc.) for specific product specific scenarios, or using mainstream API testing tools (e.g., postman for HTTP API testing, etc.), or mechanically performing manual testing, etc.

Among the API test methods described above:

if a method of writing test scripts is used, the method is only suitable for developers, and is difficult for testers or other persons without programming skills. In addition, additional investment costs may be required to maintain the test script when a change occurs to the product or test scenario.

If the mainstream test tools are used, the situation of poor universality or compatibility is faced, or only a certain test scene or a certain product is specified, or only a certain communication protocol is specified.

For cases requiring a large number of cases to be tested, or for repeated tests, the manual testing approach is obviously inefficient.

In view of this, chinese patent CN202011509272.6 discloses an API testing method and system for a service open platform, comprising: isolating the production environment gateway from the sandbox environment gateway based on the Kubernetes naming space, determining the minimum resource requirement of the sandbox environment gateway, and realizing rapid deployment of the sandbox environment gateway service based on yaml files according to the minimum resource requirement; the publisher synchronizes the API created in the production environment to the sandbox environment through the service open platform; when the publisher performs API test, an anonymous user is created in the sandbox environment gateway, so that the publisher initiates a service call request by modifying a parameter value by utilizing the anonymous role, and service call response information is acquired to determine an API debugging result; when the caller performs API test, a temporary user is created in the sandbox environment gateway, so that the call can initiate a service call request by modifying a parameter value by utilizing the temporary user role, and service call response information is acquired, so that the caller determines an API test result. The patent is applied to the API test of the application in the cloud deployment scene, and needs professional operation and maintenance personnel or development personnel with cloud deployment capability to carry out the API test, only supporting the HTTP protocol, only supporting to initiate the API test request to the back-end program on the deployment target, only supporting the API instruction of the SDK specified format, and has strong universality and relatively poor compatibility.

In the application, an API testing device firstly obtains an API file transmitted by a user, analyzes the API file, generates an API operation relation diagram and tests and knows first; the API testing device generates a first test case set according to the API operation relation diagram, triggers the service node to execute the test cases in the first test case set, and obtains an API request and a corresponding API response initiated in the process of executing the test cases in the first test case set. Providing the user with a match of API requests and API responses initiated during execution of test cases in the first set of test cases with test precedents. The API testing device can automatically complete the process of the API testing without human participation by generating, triggering and executing the test case and providing the test result from the test case. Although the patent improves the testing efficiency of the API in an automatic mode, the test case is automatically generated from the source of the test case in the form of an API document or actual flow, and the automation degree is higher, but the error is larger at the same time, and the universality and the compatibility are also very common.

Chinese patent CN202011276265.6 discloses an API test method and apparatus, an electronic device, and a computer-readable storage medium. In one embodiment of the present application, the API testing method includes: monitoring changes in the API between the banking system and its interacting party; when the API changes, notifying the banking system to modify the API; after modifying the API, starting a robot flow automation (RPA) program, completing configuration operation of a testing tool by the RPA program, and calling the testing tool to test the API. According to the embodiment of the application, the change condition of the related API of the banking system can be monitored in real time, and the automatic interface test is carried out aiming at the changed API, so that time can be saved, and the test efficiency of the API can be effectively improved. The patent expresses that an application in a specific scene is specially used for monitoring the API change of an external system, and the application cannot be automatically tested in a general scene, various different test scenes cannot be created, and whether the API of a tested system accords with the expected design or has defects cannot be verified.

In view of the above, further improvements in the prior art are necessary.

Disclosure of Invention

Aiming at the technical problems in the background technology, the invention provides a general API automatic test system which is easy to operate, strong in universality, strong in compatibility, easy to debug, high in test efficiency, capable of conveniently and efficiently creating or editing related data items in a graphical interface program, capable of carrying out uniform API interface tests on different products, different test scenes and target devices using different communication protocols and different style APIs, and capable of intuitively displaying or exporting final test results and detailed log information during the final test.

In order to solve the technical problems, the universal API automatic test system provided by the invention comprises a user interface, an executor, an execution configuration, a connection configuration library, a scheme library, a use case library and a file system; the user interface is a man-machine interaction graphical interface and is responsible for enabling interaction instructions from a user to act on the executor, the execution configuration, the connection configuration library, the scheme library, the use case library and the file system; and the state and result of the actuator is fed back to the user interface; the executor is a core module of the automatic test system and depends on the use case library, the connection configuration library, the scheme library and the execution configuration; the executor performs bidirectional data interaction with the target equipment; the executor responds to the control instruction of the user interface and feeds back the state and the execution result in the execution process to the user interface; the executor persistently stores the state in the execution process and the execution result into the file system; the execution configuration is used for configuring the behavior of the executor; the schema library is dependent on the use case library.

The universal API automated test system, wherein: information data generated by the executor in the execution process can be stored in the file system in a lasting mode, and a user can import any one of the use case library, the scheme library and the connection configuration library from the file system.

The universal API automated test system, wherein: the executor establishes interactive communication with the target equipment through the selected connection configuration library, reads a use case according to the selected scheme and sends the use case to the target equipment, and judges the result of response back of the target equipment according to the description of the use case so as to determine whether the use case passes the test.

The universal API automated test system, wherein: the connection configuration library comprises a plurality of connection configurations, and each connection configuration describes the attribute of the corresponding target device and how to establish connection with the target device and log in.

The universal API automated test system, wherein: the automated test system logs in by a login user name and password described in the connection configuration of the connection configuration library.

The universal API automated test system, wherein: the solution library contains several solutions, each describing which use cases are ordered to be composed and the test behavior of each use case.

The universal API automated test system, wherein: the case library comprises a plurality of test cases, and each test case describes a specific API interface test case.

The universal API automated test system, wherein: the file system is a file system of an operating system operated by the automated test system, and the user interface is to import data from the file system.

The universal API automated test system, wherein: the user interface may also export packet files to the file system.

The universal API automated test system, wherein: the executor will export test reports and test logs to the file system.

The universal API automatic test system comprises the following specific test flows:

(1) Creating or importing related use cases and connection configurations in the graphical interface program by combining the test scene and the test target, wherein the use cases are stored in a use case library, and the connection configurations are stored in a connection configuration library;

(2) Selecting a series of use cases from the use case library through a graphical interface program in combination with a test scene to form a test scheme, wherein the created test scheme is stored in a scheme library;

(3) Modifying data in execution configuration in a graphical interface program in combination with a test scene, selecting a certain connection configuration as a target test object, and selecting a certain scheme as a test case set;

(4) The executor is operated, at the moment, the executor can communicate with the target equipment according to the selected connection configuration, then API test is initiated to the target equipment according to the use case set in the selected scheme, and the response result of the target equipment is analyzed and judged, so that a test result is obtained, and then the test result is displayed on a graphical interface program;

(5) After the test is finished, related data and results can be exported to a file system through a graphical interface program for persistent storage.

By adopting the technical scheme, the invention has the following beneficial effects:

the general API automatic test system has simple and reasonable structural design, can conveniently and efficiently create or edit related data items in a graphical interface program, can perform uniform API interface tests on target devices of different products, different test scenes, different communication protocols and different styles of APIs, and can intuitively display or export final test results and detailed log information during the final test; the method has the specific advantages that:

(1) Easy to operate

A simple and intuitive user interface is provided that allows a developer, tester, or other person without a computer base to quickly launch the software.

(2) The universality is strong

The invention can support a plurality of different communication protocols, and does not aim at specific products or scenes; the invention can support a plurality of protocols such as TCP, HTTP, telnet, SSH, serial Port and the like, can be freely defined in a connection configuration library, and is easy to expand when a new protocol needs to be supported in the later period; an API test request can be initiated to any target device according to the definition of the connection configuration library; API instructions in any format may be supported according to the definition of the use case library; the invention provides an automatic test application under a general scene, and a user can create various different test scenes by defining a use case library, a connection configuration library, a scheme library and executing configuration by himself, and the automatic test application is mainly used for verifying whether an API of a tested system accords with an expected design or has defects.

(3) Has strong compatibility

The expected response data can be selected to be matched, advanced functions are used, and regular expressions are used for matching results so as to be compatible with various complex API use cases; the invention provides a simple and easy-to-use user interface, so that any non-professional can easily use the system by hands; the invention provides the graphical interface editing area for the manual input of the user, so that the test case can be defined more accurately; the invention can define various test schemes according to various test scenes, and can conveniently select a certain test scheme for test execution.

(4) Strong collaboration

Team cooperation can be realized by importing/exporting data packets and combining the data;

(5) Is easy to debug

And outputting, displaying and persisting detailed interactive data, test logs and state information of the use cases, highlighting key information, and enabling the use cases with failed tests to be positioned in corresponding log areas and interactive data areas in a express way, so that the use cases with failed tests can be conveniently and rapidly checked.

(6) High efficiency

The system automatically fills some information fields when newly establishing connection configuration, use cases or schemes according to the input habit of the user so as to reduce the frequency of repeatedly inputting the same content by the user; when creating the use cases, an online input function is provided, so that a user can more quickly create the use cases, and the probability of input errors is reduced more effectively; because the invention can import and export data packets, for the case of a large number of API cases, multiple persons can create cases on multiple computers in parallel and then combine the cases into one data packet, so as to improve the working efficiency.

According to the universal API automatic test system, the use cases are written, the UI of the automatic test APP can be used for connecting with the target equipment or the target system, API interaction is carried out on the target equipment or the target system in the UI, and the interaction process (comprising a request and a response) is recorded as one use case. The invention relates to the use of the API and the writing of the use case (records the use process of the API), and can write the use case more intuitively and efficiently. In addition, the invention supports three modes of selectively matching expected response data, using high-level functions and using regular expressions to match results so as to be compatible with various complex API use cases and other designs, and the writing of the use cases is simpler.

Drawings

In order to more clearly illustrate the embodiments of the invention or the technical solutions in the prior art, the drawings which are required in the description of the embodiments or the prior art will be briefly described, it being obvious that the drawings in the description below are some embodiments of the invention and that other drawings may be obtained from these drawings without inventive effort for a person skilled in the art.

FIG. 1 is a diagram of the overall architecture of a generic API automated test system of the present invention;

FIG. 2 is a timing diagram of interactions and internal operations of the universal API automation test system of the present invention during normal operation;

FIG. 3 is a test flow chart of the universal API automated test system of the present invention.

Detailed Description

The following description of the embodiments of the present invention will be made apparent and fully in view of the accompanying drawings, in which some, but not all embodiments of the invention are shown. All other embodiments, which can be made by those skilled in the art based on the embodiments of the invention without making any inventive effort, are intended to be within the scope of the invention.

The invention is further illustrated with reference to specific embodiments.

Example 1

As shown in fig. 1 and 2, the universal API automation test system provided in this embodiment includes a user interface 1, an executor 2, an execution configuration 3, a connection configuration library 4, a solution library 5, a use case library 6, and a file system 8.

The user interface 1 is a graphical interface for facilitating human-computer interaction, which is responsible for acting interaction instructions from a user on the executor 2, the execution configuration 3, the connection configuration library 4, the solution library 5, the use case library 6 and the file system 8. The user interface 1 is convenient for a user to interact with a computer program, for example, after clicking a button on the interface, the program can execute corresponding functions, and for example, the state or the execution result of the program can be displayed on a graphical interface in the form of characters or images.

The executor 2 relies on a connection configuration library 4, a solution library 5, a use case library 6 and an execution configuration 3 and is responsible for communicating with the target device 7 and performing test-related actions. The executor 2 establishes interactive communication with the target device 7 through the selected connection configuration library 4, reads a use case according to the selected scheme and sends the use case to the target device 7, and judges the result of the response of the target device 7 according to the description of the use case to determine whether the use case passes the test.

The execution configuration 3 is used to configure some behavior (such as execution times, traversal patterns, abnormal feedback patterns, etc.) of the actuator 2.

The connection configuration library 4 contains several connection configurations (each describing the properties of a device, such as IP address, communication protocol, user name and password for login, etc.), each describing the properties of the corresponding target device 7 and how to establish interactive communication with the target device 7 and log in.

The solution library 5 is in interactive communication with a use case library 6, the solution library 5 being dependent on the use case library 6 and comprising a number of solutions, each describing which use cases are ordered to be composed, and the test behaviour of each use case.

The case library 6 contains a plurality of test cases, each of which describes a specific API interface test case (including API instructions, feedback patterns, feedback matches, etc.).

The target device 7 is a hardware device actually subjected to API test, and the executor 2 communicates and information interacts with the target device 7.

The file system 8 is the file system of the operating system on which the present invention operates, the user interface 1 will import data packets from the file system 8 or export data packet files to the file system 8, and the executor 2 will export test reports and test logs to the file system 8.

Example 2

Based on example 1, in connection with fig. 2, the invention has the following detailed features:

(1) A number of different communication protocols can be supported, including but not limited to serial, TCP, telnet, SSH, HTTP etc., and automatic login (login user name and password described in the connection configuration of the connection configuration library 4) can be implemented, while in view of compatibility, how interactive communication is established with the target device 7 in particular and how login is performed is defined by the connection configuration, as to when the login user name should be sent, when the password should be sent, when it is determined that login is successful, when it is determined that login is failed, and also described in the connection configuration).

(2) The connection configuration library, the use case library and the scheme library can be conveniently packaged into a data packet file for export (the export can be carried out by clicking a button on the user interface 1, the data packet file can be sent or copied to other people after the export), and then the export is imported on another computer provided with the software, so that team cooperation requirements of 'one person editing, multiple people using' or 'multiple people editing and merging data' are realized.

(3) The result matching of the test cases, besides the conventional character string comparison, also supports advanced function matching and regular expression matching so as to cope with various complex API cases.

(4) The feedback modes of the test include automatic feedback, passive feedback and manual feedback. Wherein active feedback means that the executor 2 automatically performs test result matching according to expected response data or a matching function or a regular expression; the passive feedback means that after the executor 2 sends a tested API instruction, another query instruction is sent to query whether the previous API instruction is effective; the manual feedback means that after the executor 2 sends a test API instruction, the popup box prompts the user to check the actual test phenomenon and let the user decide whether the use case passes.

(5) When the use case is edited, online input can be performed, namely, the target equipment is connected, an API instruction is sent, and then the universal API automatic test system can automatically fill corresponding use case fields, so that the efficiency of creating/editing the test case by a user is improved, and the probability of input errors of the use case is reduced.

(6) The log generated by the executor 2 during the test, the state of each use case, the interactive data with the target device, etc. (the executor 2 updates the state of the system during the working process, such as idle state, running state, error state, etc., the interactive data generated during the interaction with the target device 7, such as the data negotiated with the options of the target device 7, the data sent to the target device 7, and the data received from the target device 7, etc., the state of the use case during the execution of the use case, such as not yet tested, running test, passing test, failed test, skipping test, abnormal test, etc., and simultaneously, in order to facilitate the later analysis of the test use case, the executor 2 records all the activities of the target device 7 during the working process, such as the log) are displayed in the graphical interface of the user interface 1 in real time and are persisted for the user to observe and later debug.

Example 3

As shown in fig. 3, the testing flow or method of the universal API automatic testing system of the present invention is:

(1) Creating or importing related use cases and connection configurations in the graphical interface program by combining the test scene and the test target, wherein the use cases are stored in a use case library, and the connection configurations are stored in a connection configuration library;

(2) Selecting a series of use cases from the use case library through a graphical interface of man-machine interaction on the user interface 1 in combination with the test scene to form a test scheme, wherein the created test scheme is stored in a scheme library;

(3) Modifying data in execution configuration in a graphical interface of man-machine interaction on a user interface 1 in combination with a test scene, selecting a certain connection configuration as a target test object, and selecting a certain scheme as a test case set;

(4) The executor is operated, at the moment, the executor can communicate with the target equipment according to the selected connection configuration, then API test is initiated to the target equipment according to the use case set in the selected scheme, the response result of the target equipment is analyzed and judged, so that a test result is obtained, and then the test result is displayed on a graphical interface of man-machine interaction on the user interface 1;

(5) After the test is finished, related data and results can be exported to a file system for persistent storage through a graphical interface of man-machine interaction on the user interface 1.

Glossary description:

API: an application programming interface, the primary purpose of which is to provide the ability for applications and developers to access a set of routines.

And (5) online input: when creating the use case, the device can be connected to the target device, then the instruction content of the tested API is directly input into the console to obtain the actual response result of the device, and then the program can automatically take the input content as the "sending data" of the use case and take the actual response result of the device as the "expected response" of the use case.

The method is easy to operate, strong in universality, strong in compatibility and easy to debug, related data items can be conveniently and efficiently created or edited in one graphical interface program, unified API interface tests can be carried out on target devices of different products, different test scenes, different communication protocols and different styles of APIs, and the final test result and detailed log information during the final test result can be intuitively displayed or exported.

Finally, it should be noted that: the above embodiments are only for illustrating the technical solution of the present invention, and not for limiting the same; although the invention has been described in detail with reference to the foregoing embodiments, it will be understood by those of ordinary skill in the art that: the technical scheme described in the foregoing embodiments can be modified or some or all of the technical features thereof can be replaced by equivalents; such modifications and substitutions do not depart from the spirit of the invention.

Claims (10)

1. A universal API automated test system, characterized by: the automatic test system comprises a user interface, an executor, execution configuration, a connection configuration library, a scheme library, a use case library and a file system;

the user interface is a man-machine interaction graphical interface and is responsible for enabling interaction instructions from a user to act on the executor, the execution configuration, the connection configuration library, the scheme library, the use case library and the file system; and the state and result of the actuator is fed back to the user interface;

the executor is a core module of the automatic test system and depends on the use case library, the connection configuration library, the scheme library and the execution configuration; the executor performs bidirectional data interaction with the target equipment; the executor responds to the control instruction of the user interface and feeds back the state and the execution result in the execution process to the user interface; the executor persistently stores the state in the execution process and the execution result into the file system;

the execution configuration is used for configuring the behavior of the executor;

the schema library is dependent on the use case library.

2. The universal API automation test system as recited in claim 1, wherein: information data generated by the executor in the execution process can be stored in the file system in a lasting mode, and a user can import any one of the use case library, the scheme library and the connection configuration library from the file system.

3. The universal API automation test system as recited in claim 1, wherein: the executor establishes interactive communication with the target equipment through the selected connection configuration library, reads a use case according to the selected scheme and sends the use case to the target equipment, and judges the result of response back of the target equipment according to the description of the use case so as to determine whether the use case passes the test.

4. The universal API automation test system as recited in claim 1, wherein: the connection configuration library comprises a plurality of connection configurations, and each connection configuration describes the attribute of the corresponding target device and how to establish connection with the target device and log in.

5. The universal API automation test system as recited in claim 4, wherein: the automated test system logs in by a login user name and password described in the connection configuration of the connection configuration library.

6. The universal API automation test system as recited in claim 1, wherein: the scheme library comprises a plurality of schemes, and each scheme describes which use cases are orderly formed and the test behavior of each use case;

the case library comprises a plurality of test cases, and each test case describes a specific API interface test case.

7. The universal API automation test system as recited in claim 1, wherein: the file system is a file system of an operating system operated by the automated test system, and the user interface is to import data from the file system.

8. The universal API automation test system as recited in claim 7, wherein: the user interface may also export packet files to the file system.

9. The universal API automation test system as recited in claim 7, wherein: the executor will export test reports and test logs to the file system.

10. The universal API automation test system as claimed in any one of claims 1 to 9, wherein: the test flow of the automatic test system specifically comprises the following steps:

(1) Creating or importing related use cases and connection configurations in the graphical interface program by combining the test scene and the test target, wherein the use cases are stored in a use case library, and the connection configurations are stored in a connection configuration library;

(2) Selecting a series of use cases from the use case library through a graphical interface program in combination with a test scene to form a test scheme, wherein the created test scheme is stored in a scheme library;

(3) Modifying data in execution configuration in a graphical interface program in combination with a test scene, selecting a certain connection configuration as a target test object, and selecting a certain scheme as a test case set;

(4) The executor is operated, at the moment, the executor can communicate with the target equipment according to the selected connection configuration, then API test is initiated to the target equipment according to the use case set in the selected scheme, and the response result of the target equipment is analyzed and judged, so that a test result is obtained, and then the test result is displayed on a graphical interface program;

(5) After the test is finished, related data and results can be exported to a file system through a graphical interface program for persistent storage.