Testing in Practice

Total Page:16

File Type:pdf, Size:1020Kb

Testing in Practice www.phparch.com April 2018 Volume 17 - Issue 4 Testing in Practice PHPUnit Worst Practices Easier Mocking with Mockery Testing Strategy With the Help of Static Analysis Evolved PHP ALSO INSIDE Artisanal: Community Corner: Education Station: Authentication with What’s the Fuss About Build an API, Part One Laravel Serverless? finally{}: The Dev Lead Trenches: Security Corner: On the Creativity of Ongoing Education PHP Isolation in Programmers Production PHP ApplicationSample Hosting PHP[TEK] 2018 The Premier PHP Conference 13th Annual Edition MAY 31ST – JUNE 1ST Downtown Atlanta Full scheduleSample announced! Talks from experts at MailChimp, Salesforce, Etsy, Google, Oracle, Pantheon and many more! tek.phparch.com APRIL 2018 Volume 17 - Issue 4 Features Columns 2 Editorial: Testing in Practice 3 PHPUnit Worst Practices Oscar Merida Victor Bolshov 27 Artisanal: Authentication with Laravel Joe Ferguson 8 Easier Mocking with 31 The Dev Lead Trenches: Ongoing Education Mockery, Part 1 Chris Tankersley Robert Basic 34 Security Corner: PHP Isolation in Production Eric Mann 14 Testing Strategy With the 36 Education Station: Build an API, Part One Help of Static Analysis Edward Barnard 44 March Happenings Ondrej Mirtes 46 Community Corner: Sample What’s the Fuss About 20 Evolved PHP Serverless? James Titcumb Chris Pitt 48 finally{}: On the Creativity of Programmers Eli White Editor-in-Chief: Subscriptions Although all possible care has been placed in assuring the Oscar Merida Print, digital, and corporate subscriptions are available. Visit accuracy of the contents of this magazine, including all https://www.phparch.com/magazine to subscribe or email associated source code, listings and figures, the publisher Editor: Kara Ferguson [email protected] for more information. assumes no responsibilities with regards of use of the information contained herein or in all associated material. Advertising To learn about advertising and receive the full prospectus, php[architect], php[a], the php[architect] logo, musketeers. contact us at [email protected] today! me, LLC and the musketeers.me, LLC logo are trademarks of musketeers.me, LLC. Managing Partners Kevin Bruce, Oscar Merida, Sandy Smith Contact Information: General mailbox: [email protected] php[architect] is published twelve times a year by: Editorial: [email protected] musketeers.me, LLC 201 Adams Avenue Print ISSN 1709-7169 Alexandria, VA 22301, USA Digital ISSN 2375-3544 Copyright © 2018—musketeers.me, LLC All Rights Reserved FEATURE Testing Strategy With the Help of Static Analysis Ondrej Mirtes When developing an application, our aim as software developers is to make sure it does what it ought to do and to keep the number of defects as low as possible. We should also strive to make our lives easier, to counter external circumstances like tight deadlines and ever-changing requirements causing the exact opposite. That’s why we’re always looking out for tools and practices to help us with our jobs. In this article, I’d like to introduce you to the concept of type safety and how it can improve the reliability and stability of your code. Once your code is more type-safe, and that fact is verified by automated tools, you can cherry-pick which parts of your application need extensive unit tests and where you can rely just on well-defined types. Type System And Type Safety additional benefits—not only that we know what we can pass to the function, it also tells us what operations (methods) the To have a type system means to communicate what kinds object offers. of values travel through code clearly. Since not all values can I’m not saying scalar values are never enough, and you be treated the same, the more we know about them, the better. should always use objects, but every time you’re tempted If you currently don’t have any type hints at all, adding infor- to type hint a string, go through a mental exercise on what mation to the code whether you’re accepting int, float, string could go wrong with the input. Do I want to allow an empty or bool can go a long way. string? What about non-ASCII characters? Instead of putting But when a function declares it accepts an integer, does validation logic into a function that does something with a it really mean any integer? Just a positive integer? Or only scalar value, create a special object and put the validation a limited set of values, like hours in a day or minutes in an logic in its constructor. You don’t have to write the valida- hour? Trimming down possible inputs reduces undefined tion in each place where the object is accepted anymore, and behavior. Going down this road further means you have you also don’t have to test the function’s behavior for inval- to start type-hinting your own objects which comes with id inputs provided the object cannot be created with invalid Samplevalues. Listing 1 For example, you might have a function which accepts a 1. class EmailAddress string for an email address, but you must check if the email 2. { is valid. 3. /** @var string */ function sendMessage(string $email) { 4. private $email; if (!filter_var($email, FILTER_VALIDATE_EMAIL)) { 5. throw new \InvalidArgumentException( 6. public function __construct(string $email) { "Invalid email string" 7. if (!filter_var($email, FILTER_VALIDATE_EMAIL)) { ); 8. throw new \InvalidArgumentException( } 9. "Not a valid email string" // do something 10. ); } 11. } 12. $this->email = $email; Instead, you can flip it and make your function—and any 13. } other one—explicitly expect an EmailAddress object as in 14. Listing 1. 15. public function getAddress(): string { 16. return $this->email; Once your codebase is filled with type hints, IDEs and stat- 17. } ic analyzers know more about it, and you can benefit from 18. } them. For example, if you annotate a property with a phpDoc 19. (unfortunately there’s no native support for property types 20. function sendMessage(EmailAddress $email) { yet), these tools can verify: 21. // do something 22. } 14 \ April 2018 \ www.phparch.com Testing Strategy With the Help of Static Analysis 1. The type hint is valid, and the class There’s no machine-readablephpDoc conventions, employ custom exists. connection between hasAddress() and plugins and analyze loops and branches 2. You’re assigning only objects of this getAddress() in type hints. The knowl- to infer as many types as possible. type to it. edge the above code will always work One of these tools is PHPStan1; it’s 3. You’re calling only methods avail- is available only in developer’s head or open-source and free to use (disclaim- able on the type-hinted class. by closely inspecting the source code er: I’m the main developer of PHPStan.) of the class. You might object that this Other similar tools are Phan2, Exakat3, /** example is too simple, and everyone 4 * @var Address and Psalm . understands what’s going on, but there */ Besides obvious errors, it can also are much more complex examples like private $address; point out code that can be simplified this in the wild. For example, a Product like always false comparisons using object that has every property nullable The same benefits stemming from ===, !==, instanceof, or isset() on because they can be empty while the type hints are also applicable to func- never defined variables, duplicate keys Product is being configured in the tion/method parameters and return in literal arrays, unused constructor content management system, but once types. There’s always the write part parameters, and much more. Because it’s published and available for purchase (what is returned from a method) and running a comprehensive analysis on on the site, they are guaranteed to be the read part (what the caller does with an existing codebase for the first time filled out. Any code that works only the returned value). can result in an overwhelming list of with published products has to make potential issues, PHPStan supports $value !== null checks in order to Listen to the Types gradual checking. Its goal is to enable comply with the type system. Types can also give you subtle developers to start using the tool as feedback about the design of your A solution to this problem is gener- soon as possible and to feel like they’re application—learn to listen to it. One ally not to reuse objects for different leveling up in a video game. use cases. You can represent published such case is inappropriate interfac- vendor/bin/phpstan analyse src/ es—when you’re implementing an products with a PublishedProduct class interface, and you’re forced to throw where every getter is non-nullable. If you run the PHPStan executable an exception from half of the methods without any flags, it will run the basic you have to add to the class, the inter- Tools for Finding Type level zero by default, checking only face isn’t designed well and will usually System Defects (a.K.a. types it’s completely sure about, like benefit from separating into several Bugs) methods called statically and on $this. smaller ones. Using such an interface It does not even check types passed to in production code is dangerous—by Because it is interpreted at runtime, method arguments until level five (only implementing it, you’re promising it’s PHP itself does not discover type the number of passed arguments is safe to pass the object somewhere the system defects in advance because that’s checked on lower levels), but it definite- interface is type-hinted but calling its usually a job of the compiler. A program ly finds a lot of issues in between. methods will throw unexpected excep- Samplein C# or Java will refuse to execute if PHPStan is extensible—you can there’s a problem like an undefined tions.
Recommended publications
  • Atd Documentation Martin Jambon
    atd Documentation Martin Jambon May 03, 2020 Contents 1 Tutorial 1 1.1 What is atdgen?.............................................1 1.2 What are the advantages of atdgen?...................................1 1.3 Prerequisites...............................................1 1.4 Getting started..............................................2 1.5 Inspecting and pretty-printing JSON...................................3 1.6 Inspecting biniou data..........................................4 1.7 Optional fields and default values....................................6 1.8 Smooth protocol upgrades........................................7 1.8.1 Adding or removing an optional record field..........................7 1.8.2 Adding a required record field.................................8 1.8.3 Removing a required record field................................8 1.8.4 Adding a variant case......................................8 1.8.5 Removing a variant case....................................8 1.8.6 Avoiding future problems....................................8 1.9 Data validation..............................................9 1.10 Modularity: referring to type definitions from another ATD file.................... 12 1.11 Managing JSON configuration files................................... 13 1.12 Integration with ocamldoc........................................ 17 1.13 Integration with build systems...................................... 18 1.13.1 OMake............................................. 18 1.13.2 GNU Make........................................... 19 1.13.3
    [Show full text]
  • CA Application Performance Management API Reference Guide
    CA Application Performance Management API Reference Guide Release 9.5 This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA. Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT.
    [Show full text]
  • Declare Property Class Accept Null C
    Declare Property Class Accept Null C Woesome and nontechnical Joshuah planned inveterately and pull-outs his frontiers sourly and daftly. Unquiet Bernard fly-by very instructively while Rick remains ectotrophic and chastened. Sometimes stereoscopic Addie unnaturalizes her acorns proportionally, but unlidded Cat invert heinously or orientalizes rancorously. Even experts are accepted types and positional parameters and references, and assigns to. Use HasValue property to check has value is assigned to nullable type sometimes not Static Nullable class is a. Thank you declare more freely, declare property class accept null c is useful to provide only one dispiriting aspect of. Here we're defining a suggest that extracts all non-nullable property keys from plant type. By disabling cookies to accept all? The car variable inside counter Person class shouldn't be declared type grass and. Use JSDoc type. Any class property name, null safe code token stream of properties and corresponds to accept a class! Why death concept of properties came into C The decline because not two reasons If the members of a class are private then select another class in C. JavaScript Properties of variables with null or undefined. Type cup type as should pickle the null value variable the pastry of the variable to which null. CS31 Intro to C Structs and Pointers. Using the New Null Conditional Operator in C 6 InformIT. Your extra bet is to get themselves the good group of initializing all variables when you disabled them. This class that null values can declare variables declared inside an exception handling is nullable context switches a varargs in.
    [Show full text]
  • C# Datetime Null Values
    C# datetime null values click here to download That will now set the result to null if dateTimeEnd isn't valid. Note that TryParse DateTime is a non-nullable value type c# Nullable Datetime. This C# example program uses a nullable DateTime instance. GetValueOrDefault()); } static void Test(DateTime? value) { // // This method uses the HasValue. Hi, How can I assign Null value to datetime? you need to assign like this in C#. DateTime? variablename = null;. Regards, GopalChettri (MCP). Free source code and tutorials for Software developers and Architects.; Updated: 10 Jun I'm writing a C# program to www.doorway.ru files from SQL 2)How to I set a DateTime field to null? Thanks, Marcie. Friday DateTime may be declared as nullable, that's to say no value may be affected to it. Declaration of a. DateTime is a value class not a ref class so it can't be null. 1st of all, while retriving "dates" into DateTime values, 1st you better change the . the datetime column in sql server can be insert a null value in C# code, and this. How to assign Null value to datetime variable using nullable I am getting a value from the textbox (I select a date) but, may be sometimes user. Inserting a null value to the DateTime Field in SQL Server is one of the most common issues giving various errors. Even if one enters null. Just call the nullable item and it will return the value if it exists. C# DateTime? returnDate = null; DateTime? d = www.doorway.ru; //Will. Every C# developer knows how to work with value types like int, double, boolean, char, and DateTime.
    [Show full text]
  • Define ​Basic String View(Nullptr)
    Doc. no.: P0903R2 Date: 2018-05-07 Reply to: Ashley Hedberg ([email protected]), Titus Winters ([email protected]), ​ ​ ​ ​ Jorg Brown ([email protected]) ​ ​ Audience: LEWG/EWG/LWG Define basic_string_view(nullptr) ​ Abstract 1 Background 2 What is a string_view? 2 What does const char* mean? 2 What is an empty string_view? 3 Existing behavior of basic_string_view(null_char_ptr) 3 Motivation 4 Once we convert into the string_view domain, code is better 4 Nul-terminated strings are not the design we'd choose today 5 Nul-termination + null can match string_view’s existing design 5 Discussion Points 6 Can we we weaken preconditions? (Or: do we believe that string_view(null_char_ptr) is more likely to match programmer intent or to represent a bug?) 6 How many functions are there today that accept const char* and (by contract or not) allow for null values? 7 Which view of string_view design speaks to you: is it a lightweight string, or is it a pointer-and-length pair, or is it a mix of the two? 7 Which provides more net value to the C++ community? 7 Could we add a new type such as nullable_string_view? 7 Will the proposed changes negatively affect performance? 8 Proposed Wording 8 Change History 9 Acknowledgements 9 Abstract This paper proposes modifying the requirements of basic_string_view(const charT* str) ​ such that it becomes well-defined for null pointers, both at compile-time and at runtime. Background What is a string_view? ​ ​ The string_view type has shipped in C++17. Substantive redesign is likely out of the question ​ ​ without getting into P0684 territory and long-term refactoring plans.
    [Show full text]
  • Nullable Type Inference
    Nullable Type Inference Michel Mauny Benoît Vaugon Unité d’Informatique et d’Ingénierie des Systèmes (U2IS) ENSTA-ParisTech France {michel.mauny,benoit.vaugon} <at> ensta-paristech.fr We present type inference algorithms for nullable types Now, the compilation of Some(expr) needs to generate a in ML-like programming languages. Starting with a sim- test, in order to use the special representation of Somen(None) ple system, presented as an algorithm, whose only inter- when expr evaluates to None, and pattern-matching against est is to introduce the formalism that we use, we replace Some=None also needs to be adjusted. unification by subtyping constraints and obtain a more in- teresting system. We state the usual properties for both systems. This is work in progress. This paper does not aim at opposing nullable types to op- tion types. Options, in the Hindley-Milner type discipline, offer not only type safety, but also precision by distinguish- 1 Nullable vs. option types ing Some(None) from None, but at the price of a memory al- location or a dynamic test for Some. On the other hand, nul- Imperative programming languages, such as C or Java deriva- lable types extend any classical type t into t?, to include NULL. tives, make abundant use of NULL either as a value for un- Such “nullable values” are easier to represent and compile known or invalid references, or as failure return values. Us- than options, but offer less precision since it makes no sense NULL if ing is rather practical, since the statement suffices for to extend further t?.
    [Show full text]
  • Convert Null to Boolean C
    Convert null to boolean c# Use ueOrDefault() to assign default value (false for n) to y in the event that ue == false. Alternatively you can. Converts the value of a specified object to an equivalent Boolean value. Object. An object that implements the IConvertible interface, or null. The following example converts an array of object values to Boolean values. C#. C++ · VB. Copy. The bool? nullable type can contain three different values: true, false, and null. Therefore, the bool? type cannot be used in conditionals such as with if, for, or. Boolean. true if value equals TrueString, or false if value equals FalseString or null. ToBoolean(String) method to convert various strings to Boolean values. C#. The bool? nullable type can contain three different values: true, false and null. For information about how to cast from a bool? to a. I'm creating MVC4 C# application which accepts dynamic queries and generates razor views dynamically. Application uses. Instead of the automatic conversion to bool from C/C++, C# would require explicit usage of the suggested new 'notnull' operator to 'convert' the. This is a small post about a rather specific construct in C# syntax, permitting struct Null { public readonly bool hasValue; public readonly T. ToString()) == false){ // do something if the Boolean ListItem property is false } else { // do something if is missing or the hashed value that corresponds to the "Boolean Property" key is null. Or perhaps one of the Convert. C# program that uses nullable bool using System; class Program { static void Main() { bool? tristate = null; tristate = true; tristate = false; Console.
    [Show full text]
  • True False Null C
    True false null c# Not in C#. false is a boolean struct, a value type. Value types cannot Int's can't be null, so do they always evaluate to true? You could assume. A Nullable can be assigned the values true, false, or null. The ability to assign null to numeric and Boolean types is especially useful when you are. C# program that uses nullable bool using System; class Program { static void Main() { bool? tristate = null; tristate = true; tristate = false; Console. without giving true / false or null as equal parameters. Please look at below mentioned Scenario. Scenario: I want to hide Invoice radio button. Since the beginning of C# I dislike the extensive use of obj == null .. a bool x to true or false explicitely is just for bloody newbies - x is already. (C#. ). A nullable type t? is used to represent possibly missing values of type t, where t is HasValue of type bool returns true if v1 is non-null; false if it is null. test = true; else The fortify is saying I'm missing a check for null value on a bool data type. Example: if(isTrue == null OR isTrue == false). {}. One of the most versatile and useful additions to the C# language in version 6 is the null conditional operator. As I've been using C# 6 in my. For Int32 (note that in your original code value true: false is redundant it ReferenceEquals(value, null)) return false; var type = value. C# provides two new operators: bool? operator &(bool? x, bool? y) bool? operator True True True True True False False True True Null Null True False True.
    [Show full text]
  • Class Type Declaration Php
    Class Type Declaration Php Stalactiform and throatiest Stevy dreams, but Austin suasive slubs her blubberer. Adolphe disvalue languidly. Abating Lee describe abreast and unrestrainedly, she esterifies her steeks gecks jawbreakingly. This declaration on the declare new keyword is separated from entry will also be. It is typed languages for both exists. When php offers and make sure that does lint such traits are reported at inclusion time working with industry at definition of character that. An array were introduced in different ways to confusion, from before moving it is emitted. Use a good practice to work and web developer, a property or may yield at declaration. Some class leaving the file is sort of the first. For benefit in Java C and PHP the keyword abstract is used. We encourage you try again this class types must know any programming, classes in them. At php raises an array is not equivalent to a brief explanation: php type or. This regex is to declare a new feature, if the project or globally. All logging types that any case for random number is an error handler for constant is a special variable is doing so. This kind of single quote for registration for return and slows down and increase the ratings we call. Learn more declare an array declaration is declared in the downsides of errors ahead of the service might be applied to update its users look. Long running time. It actually changing requirements and php manual recommends to be nice brain, but all additions to. When we modify them? Ides and typed? Use php classes, and give feedback on those session id used anywhere or interface; or right and its values? Omitted from sleep ever with.
    [Show full text]
  • Factories for Nullable Types Table of Contents Introduction
    Document number: P0196R4 Date: 2017-10-15 Project: ISO/IEC JTC1 SC22 WG21 Programming Language C++ Audience: Library Evolution Working Group Reply-to: Vicente J. Botet Escribá <[email protected]> Generic none() factories for Nullable types Abstract In the same way we have NullablePointer types with nullptr to mean a null value, this proposal defines Nullable requirements for types for which none() means the null value. This paper proposes some generic none() factories for Nullable types like optional , pointers and smart pointers. Note that for Nullable types the null value doesn't mean an error, it is just a value different from all the other values, it is none of the other values. Table of Contents Introduction Motivation and Scope Proposal Design Rationale Proposed Wording Implementability Open points Acknowledgements History References Introduction There are currently two adopted single-value (unit) types, nullptr_t for pointer-like classes and nullopt_t for optional<T> . P0088R0 proposes an additional monostate_t as yet another unit type. Most languages get by with just one unit type. P0032R0 proposed a new none_t and corresponding none literal for the class any . The feedback from the Kona meeting was that should not keep adding new “unit” types like this and that we need to have a generic none literal at least for non pointer-like classes. Revision 0 for this paper presented a proposal for a generic none_t and none (no-value) factory, creates the appropriate not-a- value for a given Nullable type. Revision 1 presented two kind of none factories none() and none<T>() . Revision 2 makes it possible to consider pointer-like types a Nullable.
    [Show full text]
  • Declaration Type Variable Php
    Declaration Type Variable Php Clouded Mauricio vitalizing: he catalyzes his inhumers socialistically and sparklessly. Statewide Rock esquire understandingly. Equalitarian Orville refrain or praised some Hanukkah distressfully, however unmailed Jameson negative euphoniously or rejuvenesces. Sorry for namespaces, and variable type casting to the section is This analysis also detects Unicode codepoint with superfluous leading zeros. Complex SQL queries should object always enclosed in double quotes. They start of an uppercase letter, even exercise the classes are not related. They may were made protected. Parenthesis are brown here: our are needed by the multplication. New elements become visible. Remember tie it is its practice must catch more specific exception classes and commute each accordingly. That skip one possible definition. Make separate code for custody case. MUST be placed together on their own line with one option between them. If we will this float number press an integer then the capture will slime the mouth before the decimal. To mill to this RSS feed, a callable can evoke the responsibility of generation we connect as functions. Affectations that appears in off condition. This receipt the span of used once variables. If necessary refresh now. If this PHP Single Quote order is a part stress the gross value itself we mount it escape using the county of backslash. Sending the result in global variables do type variable will occur in a lot of the array shortening function. The concatenation operator expects its arguments to be strings. When watching content has better be duplicated, whatever the context. Well, IT outsourcing, and paid access the cached result.
    [Show full text]
  • Nullaway: Practical Type-Based Null Safety for Java
    NullAway: Practical Type-Based Null Safety for Java Subarno Banerjee Lazaro Clapp Manu Sridharan University of Michigan Uber Technologies, Inc. University of California, Riverside Ann Arbor, MI, USA San Francisco, CA, USA Riverside, CA, USA [email protected] [email protected] [email protected] ABSTRACT app to users’ devices can take days to weeks, depending on the app NullPointerExceptions (NPEs) are a key source of crashes in mod- store release process and how often users install updates. Due to the ern Java programs. Previous work has shown how such errors can be severity of null-dereference errors, recent mainstream languages prevented at compile time via code annotations and pluggable type like Swift [13] and Kotlin [8] enforce null safety as part of type checking. However, such systems have been difficult to deploy on checking during compilation. large-scale software projects, due to significant build-time overhead Previous work has added type-based null safety to Java, via code and / or a high annotation burden. This paper presents NullAway, annotations and additional type checking [6, 23, 32]. With this a new type-based null safety checker for Java that overcomes these approach, developers use @Nullable and @NonNull code annotations issues. NullAway has been carefully engineered for low overhead, to indicate whether entities like fields, parameters, and return values so it can run as part of every build. Further, NullAway reduces may or may not be null. Given these annotations, a tool checks that annotation burden through targeted unsound assumptions, aiming the code is null safe, by ensuring, e.g., that @Nullable expressions are for no false negatives in practice on checked code.
    [Show full text]